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