linux/drivers/platform/x86/hp_accel.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/*
   3 *  hp_accel.c - Interface between LIS3LV02DL driver and HP ACPI BIOS
   4 *
   5 *  Copyright (C) 2007-2008 Yan Burman
   6 *  Copyright (C) 2008 Eric Piel
   7 *  Copyright (C) 2008-2009 Pavel Machek
   8 */
   9
  10#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  11
  12#include <linux/kernel.h>
  13#include <linux/init.h>
  14#include <linux/dmi.h>
  15#include <linux/module.h>
  16#include <linux/types.h>
  17#include <linux/platform_device.h>
  18#include <linux/interrupt.h>
  19#include <linux/delay.h>
  20#include <linux/wait.h>
  21#include <linux/poll.h>
  22#include <linux/freezer.h>
  23#include <linux/uaccess.h>
  24#include <linux/leds.h>
  25#include <linux/atomic.h>
  26#include <linux/acpi.h>
  27#include <linux/i8042.h>
  28#include <linux/serio.h>
  29#include "../../misc/lis3lv02d/lis3lv02d.h"
  30
  31#define DRIVER_NAME     "hp_accel"
  32#define ACPI_MDPS_CLASS "accelerometer"
  33
  34/* Delayed LEDs infrastructure ------------------------------------ */
  35
  36/* Special LED class that can defer work */
  37struct delayed_led_classdev {
  38        struct led_classdev led_classdev;
  39        struct work_struct work;
  40        enum led_brightness new_brightness;
  41
  42        unsigned int led;               /* For driver */
  43        void (*set_brightness)(struct delayed_led_classdev *data, enum led_brightness value);
  44};
  45
  46static inline void delayed_set_status_worker(struct work_struct *work)
  47{
  48        struct delayed_led_classdev *data =
  49                        container_of(work, struct delayed_led_classdev, work);
  50
  51        data->set_brightness(data, data->new_brightness);
  52}
  53
  54static inline void delayed_sysfs_set(struct led_classdev *led_cdev,
  55                              enum led_brightness brightness)
  56{
  57        struct delayed_led_classdev *data = container_of(led_cdev,
  58                             struct delayed_led_classdev, led_classdev);
  59        data->new_brightness = brightness;
  60        schedule_work(&data->work);
  61}
  62
  63/* HP-specific accelerometer driver ------------------------------------ */
  64
  65/* e0 25, e0 26, e0 27, e0 28 are scan codes that the accelerometer with acpi id
  66 * HPQ6000 sends through the keyboard bus */
  67#define ACCEL_1 0x25
  68#define ACCEL_2 0x26
  69#define ACCEL_3 0x27
  70#define ACCEL_4 0x28
  71
  72/* For automatic insertion of the module */
  73static const struct acpi_device_id lis3lv02d_device_ids[] = {
  74        {"HPQ0004", 0}, /* HP Mobile Data Protection System PNP */
  75        {"HPQ6000", 0}, /* HP Mobile Data Protection System PNP */
  76        {"HPQ6007", 0}, /* HP Mobile Data Protection System PNP */
  77        {"", 0},
  78};
  79MODULE_DEVICE_TABLE(acpi, lis3lv02d_device_ids);
  80
  81
  82/**
  83 * lis3lv02d_acpi_init - ACPI _INI method: initialize the device.
  84 * @lis3: pointer to the device struct
  85 *
  86 * Returns 0 on success.
  87 */
  88static int lis3lv02d_acpi_init(struct lis3lv02d *lis3)
  89{
  90        struct acpi_device *dev = lis3->bus_priv;
  91        if (acpi_evaluate_object(dev->handle, METHOD_NAME__INI,
  92                                 NULL, NULL) != AE_OK)
  93                return -EINVAL;
  94
  95        return 0;
  96}
  97
  98/**
  99 * lis3lv02d_acpi_read - ACPI ALRD method: read a register
 100 * @lis3: pointer to the device struct
 101 * @reg:    the register to read
 102 * @ret:    result of the operation
 103 *
 104 * Returns 0 on success.
 105 */
 106static int lis3lv02d_acpi_read(struct lis3lv02d *lis3, int reg, u8 *ret)
 107{
 108        struct acpi_device *dev = lis3->bus_priv;
 109        union acpi_object arg0 = { ACPI_TYPE_INTEGER };
 110        struct acpi_object_list args = { 1, &arg0 };
 111        unsigned long long lret;
 112        acpi_status status;
 113
 114        arg0.integer.value = reg;
 115
 116        status = acpi_evaluate_integer(dev->handle, "ALRD", &args, &lret);
 117        if (ACPI_FAILURE(status))
 118                return -EINVAL;
 119        *ret = lret;
 120        return 0;
 121}
 122
 123/**
 124 * lis3lv02d_acpi_write - ACPI ALWR method: write to a register
 125 * @lis3: pointer to the device struct
 126 * @reg:    the register to write to
 127 * @val:    the value to write
 128 *
 129 * Returns 0 on success.
 130 */
 131static int lis3lv02d_acpi_write(struct lis3lv02d *lis3, int reg, u8 val)
 132{
 133        struct acpi_device *dev = lis3->bus_priv;
 134        unsigned long long ret; /* Not used when writting */
 135        union acpi_object in_obj[2];
 136        struct acpi_object_list args = { 2, in_obj };
 137
 138        in_obj[0].type          = ACPI_TYPE_INTEGER;
 139        in_obj[0].integer.value = reg;
 140        in_obj[1].type          = ACPI_TYPE_INTEGER;
 141        in_obj[1].integer.value = val;
 142
 143        if (acpi_evaluate_integer(dev->handle, "ALWR", &args, &ret) != AE_OK)
 144                return -EINVAL;
 145
 146        return 0;
 147}
 148
 149static int lis3lv02d_dmi_matched(const struct dmi_system_id *dmi)
 150{
 151        lis3_dev.ac = *((union axis_conversion *)dmi->driver_data);
 152        pr_info("hardware type %s found\n", dmi->ident);
 153
 154        return 1;
 155}
 156
 157/* Represents, for each axis seen by userspace, the corresponding hw axis (+1).
 158 * If the value is negative, the opposite of the hw value is used. */
 159#define DEFINE_CONV(name, x, y, z)                            \
 160        static union axis_conversion lis3lv02d_axis_##name = \
 161                { .as_array = { x, y, z } }
 162DEFINE_CONV(normal, 1, 2, 3);
 163DEFINE_CONV(y_inverted, 1, -2, 3);
 164DEFINE_CONV(x_inverted, -1, 2, 3);
 165DEFINE_CONV(x_inverted_usd, -1, 2, -3);
 166DEFINE_CONV(z_inverted, 1, 2, -3);
 167DEFINE_CONV(xy_swap, 2, 1, 3);
 168DEFINE_CONV(xy_rotated_left, -2, 1, 3);
 169DEFINE_CONV(xy_rotated_left_usd, -2, 1, -3);
 170DEFINE_CONV(xy_swap_inverted, -2, -1, 3);
 171DEFINE_CONV(xy_rotated_right, 2, -1, 3);
 172DEFINE_CONV(xy_swap_yz_inverted, 2, -1, -3);
 173
 174#define AXIS_DMI_MATCH(_ident, _name, _axis) {          \
 175        .ident = _ident,                                \
 176        .callback = lis3lv02d_dmi_matched,              \
 177        .matches = {                                    \
 178                DMI_MATCH(DMI_PRODUCT_NAME, _name)      \
 179        },                                              \
 180        .driver_data = &lis3lv02d_axis_##_axis          \
 181}
 182
 183#define AXIS_DMI_MATCH2(_ident, _class1, _name1,        \
 184                                _class2, _name2,        \
 185                                _axis) {                \
 186        .ident = _ident,                                \
 187        .callback = lis3lv02d_dmi_matched,              \
 188        .matches = {                                    \
 189                DMI_MATCH(DMI_##_class1, _name1),       \
 190                DMI_MATCH(DMI_##_class2, _name2),       \
 191        },                                              \
 192        .driver_data = &lis3lv02d_axis_##_axis          \
 193}
 194static const struct dmi_system_id lis3lv02d_dmi_ids[] = {
 195        /* product names are truncated to match all kinds of a same model */
 196        AXIS_DMI_MATCH("NC64x0", "HP Compaq nc64", x_inverted),
 197        AXIS_DMI_MATCH("NC84x0", "HP Compaq nc84", z_inverted),
 198        AXIS_DMI_MATCH("NX9420", "HP Compaq nx9420", x_inverted),
 199        AXIS_DMI_MATCH("NW9440", "HP Compaq nw9440", x_inverted),
 200        AXIS_DMI_MATCH("NC2510", "HP Compaq 2510", y_inverted),
 201        AXIS_DMI_MATCH("NC2710", "HP Compaq 2710", xy_swap),
 202        AXIS_DMI_MATCH("NC8510", "HP Compaq 8510", xy_swap_inverted),
 203        AXIS_DMI_MATCH("HP2133", "HP 2133", xy_rotated_left),
 204        AXIS_DMI_MATCH("HP2140", "HP 2140", xy_swap_inverted),
 205        AXIS_DMI_MATCH("NC653x", "HP Compaq 653", xy_rotated_left_usd),
 206        AXIS_DMI_MATCH("NC6730b", "HP Compaq 6730b", xy_rotated_left_usd),
 207        AXIS_DMI_MATCH("NC6730s", "HP Compaq 6730s", xy_swap),
 208        AXIS_DMI_MATCH("NC651xx", "HP Compaq 651", xy_rotated_right),
 209        AXIS_DMI_MATCH("NC6710x", "HP Compaq 6710", xy_swap_yz_inverted),
 210        AXIS_DMI_MATCH("NC6715x", "HP Compaq 6715", y_inverted),
 211        AXIS_DMI_MATCH("NC693xx", "HP EliteBook 693", xy_rotated_right),
 212        AXIS_DMI_MATCH("NC693xx", "HP EliteBook 853", xy_swap),
 213        AXIS_DMI_MATCH("NC854xx", "HP EliteBook 854", y_inverted),
 214        AXIS_DMI_MATCH("NC273xx", "HP EliteBook 273", y_inverted),
 215        /* Intel-based HP Pavilion dv5 */
 216        AXIS_DMI_MATCH2("HPDV5_I",
 217                        PRODUCT_NAME, "HP Pavilion dv5",
 218                        BOARD_NAME, "3603",
 219                        x_inverted),
 220        /* AMD-based HP Pavilion dv5 */
 221        AXIS_DMI_MATCH2("HPDV5_A",
 222                        PRODUCT_NAME, "HP Pavilion dv5",
 223                        BOARD_NAME, "3600",
 224                        y_inverted),
 225        AXIS_DMI_MATCH("DV7", "HP Pavilion dv7", x_inverted),
 226        AXIS_DMI_MATCH("HP8710", "HP Compaq 8710", y_inverted),
 227        AXIS_DMI_MATCH("HDX18", "HP HDX 18", x_inverted),
 228        AXIS_DMI_MATCH("HPB432x", "HP ProBook 432", xy_rotated_left),
 229        AXIS_DMI_MATCH("HPB440G3", "HP ProBook 440 G3", x_inverted_usd),
 230        AXIS_DMI_MATCH("HPB440G4", "HP ProBook 440 G4", x_inverted),
 231        AXIS_DMI_MATCH("HPB442x", "HP ProBook 442", xy_rotated_left),
 232        AXIS_DMI_MATCH("HPB450G0", "HP ProBook 450 G0", x_inverted),
 233        AXIS_DMI_MATCH("HPB452x", "HP ProBook 452", y_inverted),
 234        AXIS_DMI_MATCH("HPB522x", "HP ProBook 522", xy_swap),
 235        AXIS_DMI_MATCH("HPB532x", "HP ProBook 532", y_inverted),
 236        AXIS_DMI_MATCH("HPB655x", "HP ProBook 655", xy_swap_inverted),
 237        AXIS_DMI_MATCH("Mini510x", "HP Mini 510", xy_rotated_left_usd),
 238        AXIS_DMI_MATCH("HPB63xx", "HP ProBook 63", xy_swap),
 239        AXIS_DMI_MATCH("HPB64xx", "HP ProBook 64", xy_swap),
 240        AXIS_DMI_MATCH("HPB64xx", "HP EliteBook 84", xy_swap),
 241        AXIS_DMI_MATCH("HPB65xx", "HP ProBook 65", x_inverted),
 242        AXIS_DMI_MATCH("HPZBook15", "HP ZBook 15", x_inverted),
 243        AXIS_DMI_MATCH("HPZBook17G5", "HP ZBook 17 G5", x_inverted),
 244        AXIS_DMI_MATCH("HPZBook17", "HP ZBook 17", xy_swap_yz_inverted),
 245        { NULL, }
 246/* Laptop models without axis info (yet):
 247 * "NC6910" "HP Compaq 6910"
 248 * "NC2400" "HP Compaq nc2400"
 249 * "NX74x0" "HP Compaq nx74"
 250 * "NX6325" "HP Compaq nx6325"
 251 * "NC4400" "HP Compaq nc4400"
 252 */
 253};
 254
 255static void hpled_set(struct delayed_led_classdev *led_cdev, enum led_brightness value)
 256{
 257        struct acpi_device *dev = lis3_dev.bus_priv;
 258        unsigned long long ret; /* Not used when writing */
 259        union acpi_object in_obj[1];
 260        struct acpi_object_list args = { 1, in_obj };
 261
 262        in_obj[0].type          = ACPI_TYPE_INTEGER;
 263        in_obj[0].integer.value = !!value;
 264
 265        acpi_evaluate_integer(dev->handle, "ALED", &args, &ret);
 266}
 267
 268static struct delayed_led_classdev hpled_led = {
 269        .led_classdev = {
 270                .name                   = "hp::hddprotect",
 271                .default_trigger        = "none",
 272                .brightness_set         = delayed_sysfs_set,
 273                .flags                  = LED_CORE_SUSPENDRESUME,
 274        },
 275        .set_brightness = hpled_set,
 276};
 277
 278static acpi_status
 279lis3lv02d_get_resource(struct acpi_resource *resource, void *context)
 280{
 281        if (resource->type == ACPI_RESOURCE_TYPE_EXTENDED_IRQ) {
 282                struct acpi_resource_extended_irq *irq;
 283                u32 *device_irq = context;
 284
 285                irq = &resource->data.extended_irq;
 286                *device_irq = irq->interrupts[0];
 287        }
 288
 289        return AE_OK;
 290}
 291
 292static void lis3lv02d_enum_resources(struct acpi_device *device)
 293{
 294        acpi_status status;
 295
 296        status = acpi_walk_resources(device->handle, METHOD_NAME__CRS,
 297                                        lis3lv02d_get_resource, &lis3_dev.irq);
 298        if (ACPI_FAILURE(status))
 299                printk(KERN_DEBUG DRIVER_NAME ": Error getting resources\n");
 300}
 301
 302static bool hp_accel_i8042_filter(unsigned char data, unsigned char str,
 303                                  struct serio *port)
 304{
 305        static bool extended;
 306
 307        if (str & I8042_STR_AUXDATA)
 308                return false;
 309
 310        if (data == 0xe0) {
 311                extended = true;
 312                return true;
 313        } else if (unlikely(extended)) {
 314                extended = false;
 315
 316                switch (data) {
 317                case ACCEL_1:
 318                case ACCEL_2:
 319                case ACCEL_3:
 320                case ACCEL_4:
 321                        return true;
 322                default:
 323                        serio_interrupt(port, 0xe0, 0);
 324                        return false;
 325                }
 326        }
 327
 328        return false;
 329}
 330
 331static int lis3lv02d_add(struct acpi_device *device)
 332{
 333        int ret;
 334
 335        if (!device)
 336                return -EINVAL;
 337
 338        lis3_dev.bus_priv = device;
 339        lis3_dev.init = lis3lv02d_acpi_init;
 340        lis3_dev.read = lis3lv02d_acpi_read;
 341        lis3_dev.write = lis3lv02d_acpi_write;
 342        strcpy(acpi_device_name(device), DRIVER_NAME);
 343        strcpy(acpi_device_class(device), ACPI_MDPS_CLASS);
 344        device->driver_data = &lis3_dev;
 345
 346        /* obtain IRQ number of our device from ACPI */
 347        lis3lv02d_enum_resources(device);
 348
 349        /* If possible use a "standard" axes order */
 350        if (lis3_dev.ac.x && lis3_dev.ac.y && lis3_dev.ac.z) {
 351                pr_info("Using custom axes %d,%d,%d\n",
 352                        lis3_dev.ac.x, lis3_dev.ac.y, lis3_dev.ac.z);
 353        } else if (dmi_check_system(lis3lv02d_dmi_ids) == 0) {
 354                pr_info("laptop model unknown, using default axes configuration\n");
 355                lis3_dev.ac = lis3lv02d_axis_normal;
 356        }
 357
 358        /* call the core layer do its init */
 359        ret = lis3lv02d_init_device(&lis3_dev);
 360        if (ret)
 361                return ret;
 362
 363        /* filter to remove HPQ6000 accelerometer data
 364         * from keyboard bus stream */
 365        if (strstr(dev_name(&device->dev), "HPQ6000"))
 366                i8042_install_filter(hp_accel_i8042_filter);
 367
 368        INIT_WORK(&hpled_led.work, delayed_set_status_worker);
 369        ret = led_classdev_register(NULL, &hpled_led.led_classdev);
 370        if (ret) {
 371                lis3lv02d_joystick_disable(&lis3_dev);
 372                lis3lv02d_poweroff(&lis3_dev);
 373                flush_work(&hpled_led.work);
 374                return ret;
 375        }
 376
 377        return ret;
 378}
 379
 380static int lis3lv02d_remove(struct acpi_device *device)
 381{
 382        if (!device)
 383                return -EINVAL;
 384
 385        i8042_remove_filter(hp_accel_i8042_filter);
 386        lis3lv02d_joystick_disable(&lis3_dev);
 387        lis3lv02d_poweroff(&lis3_dev);
 388
 389        led_classdev_unregister(&hpled_led.led_classdev);
 390        flush_work(&hpled_led.work);
 391
 392        return lis3lv02d_remove_fs(&lis3_dev);
 393}
 394
 395
 396#ifdef CONFIG_PM_SLEEP
 397static int lis3lv02d_suspend(struct device *dev)
 398{
 399        /* make sure the device is off when we suspend */
 400        lis3lv02d_poweroff(&lis3_dev);
 401        return 0;
 402}
 403
 404static int lis3lv02d_resume(struct device *dev)
 405{
 406        lis3lv02d_poweron(&lis3_dev);
 407        return 0;
 408}
 409
 410static SIMPLE_DEV_PM_OPS(hp_accel_pm, lis3lv02d_suspend, lis3lv02d_resume);
 411#define HP_ACCEL_PM (&hp_accel_pm)
 412#else
 413#define HP_ACCEL_PM NULL
 414#endif
 415
 416/* For the HP MDPS aka 3D Driveguard */
 417static struct acpi_driver lis3lv02d_driver = {
 418        .name  = DRIVER_NAME,
 419        .class = ACPI_MDPS_CLASS,
 420        .ids   = lis3lv02d_device_ids,
 421        .ops = {
 422                .add     = lis3lv02d_add,
 423                .remove  = lis3lv02d_remove,
 424        },
 425        .drv.pm = HP_ACCEL_PM,
 426};
 427module_acpi_driver(lis3lv02d_driver);
 428
 429MODULE_DESCRIPTION("Glue between LIS3LV02Dx and HP ACPI BIOS and support for disk protection LED.");
 430MODULE_AUTHOR("Yan Burman, Eric Piel, Pavel Machek");
 431MODULE_LICENSE("GPL");
 432