1b886d83cSThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only 261cd4822SLejun Zhu /* 361cd4822SLejun Zhu * Supports for the button array on SoC tablets originally running 461cd4822SLejun Zhu * Windows 8. 561cd4822SLejun Zhu * 661cd4822SLejun Zhu * (C) Copyright 2014 Intel Corporation 761cd4822SLejun Zhu */ 861cd4822SLejun Zhu 961cd4822SLejun Zhu #include <linux/module.h> 1061cd4822SLejun Zhu #include <linux/input.h> 1161cd4822SLejun Zhu #include <linux/init.h> 1261cd4822SLejun Zhu #include <linux/kernel.h> 1361cd4822SLejun Zhu #include <linux/acpi.h> 1461cd4822SLejun Zhu #include <linux/gpio/consumer.h> 1561cd4822SLejun Zhu #include <linux/gpio_keys.h> 16be8e7a7eSBenjamin Tissoires #include <linux/gpio.h> 1761cd4822SLejun Zhu #include <linux/platform_device.h> 1861cd4822SLejun Zhu 1961cd4822SLejun Zhu struct soc_button_info { 2061cd4822SLejun Zhu const char *name; 2161cd4822SLejun Zhu int acpi_index; 2261cd4822SLejun Zhu unsigned int event_type; 2361cd4822SLejun Zhu unsigned int event_code; 2461cd4822SLejun Zhu bool autorepeat; 2561cd4822SLejun Zhu bool wakeup; 2661cd4822SLejun Zhu }; 2761cd4822SLejun Zhu 28c3941593SMaximilian Luz struct soc_device_data { 29c3941593SMaximilian Luz const struct soc_button_info *button_info; 30c3941593SMaximilian Luz int (*check)(struct device *dev); 31c3941593SMaximilian Luz }; 32c3941593SMaximilian Luz 3361cd4822SLejun Zhu /* 3461cd4822SLejun Zhu * Some of the buttons like volume up/down are auto repeat, while others 3561cd4822SLejun Zhu * are not. To support both, we register two platform devices, and put 3661cd4822SLejun Zhu * buttons into them based on whether the key should be auto repeat. 3761cd4822SLejun Zhu */ 3861cd4822SLejun Zhu #define BUTTON_TYPES 2 3961cd4822SLejun Zhu 4061cd4822SLejun Zhu struct soc_button_data { 4161cd4822SLejun Zhu struct platform_device *children[BUTTON_TYPES]; 4261cd4822SLejun Zhu }; 4361cd4822SLejun Zhu 4461cd4822SLejun Zhu /* 4561cd4822SLejun Zhu * Get the Nth GPIO number from the ACPI object. 4661cd4822SLejun Zhu */ 4761cd4822SLejun Zhu static int soc_button_lookup_gpio(struct device *dev, int acpi_index) 4861cd4822SLejun Zhu { 4961cd4822SLejun Zhu struct gpio_desc *desc; 5061cd4822SLejun Zhu int gpio; 5161cd4822SLejun Zhu 52a01cd170SHans de Goede desc = gpiod_get_index(dev, NULL, acpi_index, GPIOD_ASIS); 5361cd4822SLejun Zhu if (IS_ERR(desc)) 5461cd4822SLejun Zhu return PTR_ERR(desc); 5561cd4822SLejun Zhu 5661cd4822SLejun Zhu gpio = desc_to_gpio(desc); 5761cd4822SLejun Zhu 5861cd4822SLejun Zhu gpiod_put(desc); 5961cd4822SLejun Zhu 6061cd4822SLejun Zhu return gpio; 6161cd4822SLejun Zhu } 6261cd4822SLejun Zhu 6361cd4822SLejun Zhu static struct platform_device * 64042e1c79SJin Yao soc_button_device_create(struct platform_device *pdev, 6561cd4822SLejun Zhu const struct soc_button_info *button_info, 6661cd4822SLejun Zhu bool autorepeat) 6761cd4822SLejun Zhu { 6861cd4822SLejun Zhu const struct soc_button_info *info; 6961cd4822SLejun Zhu struct platform_device *pd; 7061cd4822SLejun Zhu struct gpio_keys_button *gpio_keys; 7161cd4822SLejun Zhu struct gpio_keys_platform_data *gpio_keys_pdata; 7261cd4822SLejun Zhu int n_buttons = 0; 7361cd4822SLejun Zhu int gpio; 7461cd4822SLejun Zhu int error; 7561cd4822SLejun Zhu 767283b47dSHans de Goede for (info = button_info; info->name; info++) 777283b47dSHans de Goede if (info->autorepeat == autorepeat) 787283b47dSHans de Goede n_buttons++; 797283b47dSHans de Goede 8061cd4822SLejun Zhu gpio_keys_pdata = devm_kzalloc(&pdev->dev, 8161cd4822SLejun Zhu sizeof(*gpio_keys_pdata) + 827283b47dSHans de Goede sizeof(*gpio_keys) * n_buttons, 8361cd4822SLejun Zhu GFP_KERNEL); 8491cf07cdSPramod Gurav if (!gpio_keys_pdata) 8591cf07cdSPramod Gurav return ERR_PTR(-ENOMEM); 8691cf07cdSPramod Gurav 8761cd4822SLejun Zhu gpio_keys = (void *)(gpio_keys_pdata + 1); 887283b47dSHans de Goede n_buttons = 0; 8961cd4822SLejun Zhu 9061cd4822SLejun Zhu for (info = button_info; info->name; info++) { 9161cd4822SLejun Zhu if (info->autorepeat != autorepeat) 9261cd4822SLejun Zhu continue; 9361cd4822SLejun Zhu 9461cd4822SLejun Zhu gpio = soc_button_lookup_gpio(&pdev->dev, info->acpi_index); 95bcf05957SHans de Goede if (!gpio_is_valid(gpio)) { 96bcf05957SHans de Goede /* 97bcf05957SHans de Goede * Skip GPIO if not present. Note we deliberately 98bcf05957SHans de Goede * ignore -EPROBE_DEFER errors here. On some devices 99bcf05957SHans de Goede * Intel is using so called virtual GPIOs which are not 100bcf05957SHans de Goede * GPIOs at all but some way for AML code to check some 101bcf05957SHans de Goede * random status bits without need a custom opregion. 102bcf05957SHans de Goede * In some cases the resources table we parse points to 103bcf05957SHans de Goede * such a virtual GPIO, since these are not real GPIOs 104bcf05957SHans de Goede * we do not have a driver for these so they will never 105bcf05957SHans de Goede * show up, therefore we ignore -EPROBE_DEFER. 106bcf05957SHans de Goede */ 10761cd4822SLejun Zhu continue; 108c3941593SMaximilian Luz } 10961cd4822SLejun Zhu 11061cd4822SLejun Zhu gpio_keys[n_buttons].type = info->event_type; 11161cd4822SLejun Zhu gpio_keys[n_buttons].code = info->event_code; 11261cd4822SLejun Zhu gpio_keys[n_buttons].gpio = gpio; 11361cd4822SLejun Zhu gpio_keys[n_buttons].active_low = 1; 11461cd4822SLejun Zhu gpio_keys[n_buttons].desc = info->name; 11561cd4822SLejun Zhu gpio_keys[n_buttons].wakeup = info->wakeup; 1165c4fa2a6SHans de Goede /* These devices often use cheap buttons, use 50 ms debounce */ 1175c4fa2a6SHans de Goede gpio_keys[n_buttons].debounce_interval = 50; 11861cd4822SLejun Zhu n_buttons++; 11961cd4822SLejun Zhu } 12061cd4822SLejun Zhu 12161cd4822SLejun Zhu if (n_buttons == 0) { 12261cd4822SLejun Zhu error = -ENODEV; 12361cd4822SLejun Zhu goto err_free_mem; 12461cd4822SLejun Zhu } 12561cd4822SLejun Zhu 12661cd4822SLejun Zhu gpio_keys_pdata->buttons = gpio_keys; 12761cd4822SLejun Zhu gpio_keys_pdata->nbuttons = n_buttons; 12861cd4822SLejun Zhu gpio_keys_pdata->rep = autorepeat; 12961cd4822SLejun Zhu 13053119e51SEnrico Weigelt pd = platform_device_register_resndata(&pdev->dev, "gpio-keys", 13153119e51SEnrico Weigelt PLATFORM_DEVID_AUTO, NULL, 0, 13253119e51SEnrico Weigelt gpio_keys_pdata, 13353119e51SEnrico Weigelt sizeof(*gpio_keys_pdata)); 13453119e51SEnrico Weigelt error = PTR_ERR_OR_ZERO(pd); 13553119e51SEnrico Weigelt if (error) { 13653119e51SEnrico Weigelt dev_err(&pdev->dev, 13753119e51SEnrico Weigelt "failed registering gpio-keys: %d\n", error); 13861cd4822SLejun Zhu goto err_free_mem; 13961cd4822SLejun Zhu } 14061cd4822SLejun Zhu 14161cd4822SLejun Zhu return pd; 14261cd4822SLejun Zhu 14361cd4822SLejun Zhu err_free_mem: 14461cd4822SLejun Zhu devm_kfree(&pdev->dev, gpio_keys_pdata); 14561cd4822SLejun Zhu return ERR_PTR(error); 14661cd4822SLejun Zhu } 14761cd4822SLejun Zhu 1484c3362f4SHans de Goede static int soc_button_get_acpi_object_int(const union acpi_object *obj) 1494c3362f4SHans de Goede { 1504c3362f4SHans de Goede if (obj->type != ACPI_TYPE_INTEGER) 1514c3362f4SHans de Goede return -1; 1524c3362f4SHans de Goede 1534c3362f4SHans de Goede return obj->integer.value; 1544c3362f4SHans de Goede } 1554c3362f4SHans de Goede 1564c3362f4SHans de Goede /* Parse a single ACPI0011 _DSD button descriptor */ 1574c3362f4SHans de Goede static int soc_button_parse_btn_desc(struct device *dev, 1584c3362f4SHans de Goede const union acpi_object *desc, 1594c3362f4SHans de Goede int collection_uid, 1604c3362f4SHans de Goede struct soc_button_info *info) 1614c3362f4SHans de Goede { 1624c3362f4SHans de Goede int upage, usage; 1634c3362f4SHans de Goede 1644c3362f4SHans de Goede if (desc->type != ACPI_TYPE_PACKAGE || 1654c3362f4SHans de Goede desc->package.count != 5 || 1664c3362f4SHans de Goede /* First byte should be 1 (control) */ 1674c3362f4SHans de Goede soc_button_get_acpi_object_int(&desc->package.elements[0]) != 1 || 1684c3362f4SHans de Goede /* Third byte should be collection uid */ 1694c3362f4SHans de Goede soc_button_get_acpi_object_int(&desc->package.elements[2]) != 1704c3362f4SHans de Goede collection_uid) { 1714c3362f4SHans de Goede dev_err(dev, "Invalid ACPI Button Descriptor\n"); 1724c3362f4SHans de Goede return -ENODEV; 1734c3362f4SHans de Goede } 1744c3362f4SHans de Goede 1754c3362f4SHans de Goede info->event_type = EV_KEY; 1764c3362f4SHans de Goede info->acpi_index = 1774c3362f4SHans de Goede soc_button_get_acpi_object_int(&desc->package.elements[1]); 1784c3362f4SHans de Goede upage = soc_button_get_acpi_object_int(&desc->package.elements[3]); 1794c3362f4SHans de Goede usage = soc_button_get_acpi_object_int(&desc->package.elements[4]); 1804c3362f4SHans de Goede 1814c3362f4SHans de Goede /* 1824c3362f4SHans de Goede * The UUID: fa6bd625-9ce8-470d-a2c7-b3ca36c4282e descriptors use HID 1834c3362f4SHans de Goede * usage page and usage codes, but otherwise the device is not HID 1844c3362f4SHans de Goede * compliant: it uses one irq per button instead of generating HID 1854c3362f4SHans de Goede * input reports and some buttons should generate wakeups where as 1864c3362f4SHans de Goede * others should not, so we cannot use the HID subsystem. 1874c3362f4SHans de Goede * 1884c3362f4SHans de Goede * Luckily all devices only use a few usage page + usage combinations, 1894c3362f4SHans de Goede * so we can simply check for the known combinations here. 1904c3362f4SHans de Goede */ 1914c3362f4SHans de Goede if (upage == 0x01 && usage == 0x81) { 1924c3362f4SHans de Goede info->name = "power"; 1934c3362f4SHans de Goede info->event_code = KEY_POWER; 1944c3362f4SHans de Goede info->wakeup = true; 19539be9b6dSHans de Goede } else if (upage == 0x01 && usage == 0xca) { 19639be9b6dSHans de Goede info->name = "rotation lock switch"; 19739be9b6dSHans de Goede info->event_type = EV_SW; 19839be9b6dSHans de Goede info->event_code = SW_ROTATE_LOCK; 1994c3362f4SHans de Goede } else if (upage == 0x07 && usage == 0xe3) { 2004c3362f4SHans de Goede info->name = "home"; 201dd224085SHans de Goede info->event_code = KEY_LEFTMETA; 2024c3362f4SHans de Goede info->wakeup = true; 2034c3362f4SHans de Goede } else if (upage == 0x0c && usage == 0xe9) { 2044c3362f4SHans de Goede info->name = "volume_up"; 2054c3362f4SHans de Goede info->event_code = KEY_VOLUMEUP; 2064c3362f4SHans de Goede info->autorepeat = true; 2074c3362f4SHans de Goede } else if (upage == 0x0c && usage == 0xea) { 2084c3362f4SHans de Goede info->name = "volume_down"; 2094c3362f4SHans de Goede info->event_code = KEY_VOLUMEDOWN; 2104c3362f4SHans de Goede info->autorepeat = true; 2114c3362f4SHans de Goede } else { 2124c3362f4SHans de Goede dev_warn(dev, "Unknown button index %d upage %02x usage %02x, ignoring\n", 2134c3362f4SHans de Goede info->acpi_index, upage, usage); 2144c3362f4SHans de Goede info->name = "unknown"; 2154c3362f4SHans de Goede info->event_code = KEY_RESERVED; 2164c3362f4SHans de Goede } 2174c3362f4SHans de Goede 2184c3362f4SHans de Goede return 0; 2194c3362f4SHans de Goede } 2204c3362f4SHans de Goede 2214c3362f4SHans de Goede /* ACPI0011 _DSD btns descriptors UUID: fa6bd625-9ce8-470d-a2c7-b3ca36c4282e */ 2224c3362f4SHans de Goede static const u8 btns_desc_uuid[16] = { 2234c3362f4SHans de Goede 0x25, 0xd6, 0x6b, 0xfa, 0xe8, 0x9c, 0x0d, 0x47, 2244c3362f4SHans de Goede 0xa2, 0xc7, 0xb3, 0xca, 0x36, 0xc4, 0x28, 0x2e 2254c3362f4SHans de Goede }; 2264c3362f4SHans de Goede 2274c3362f4SHans de Goede /* Parse ACPI0011 _DSD button descriptors */ 2284c3362f4SHans de Goede static struct soc_button_info *soc_button_get_button_info(struct device *dev) 2294c3362f4SHans de Goede { 2304c3362f4SHans de Goede struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER }; 2314c3362f4SHans de Goede const union acpi_object *desc, *el0, *uuid, *btns_desc = NULL; 2324c3362f4SHans de Goede struct soc_button_info *button_info; 2334c3362f4SHans de Goede acpi_status status; 2344c3362f4SHans de Goede int i, btn, collection_uid = -1; 2354c3362f4SHans de Goede 2364c3362f4SHans de Goede status = acpi_evaluate_object_typed(ACPI_HANDLE(dev), "_DSD", NULL, 2374c3362f4SHans de Goede &buf, ACPI_TYPE_PACKAGE); 2384c3362f4SHans de Goede if (ACPI_FAILURE(status)) { 2394c3362f4SHans de Goede dev_err(dev, "ACPI _DSD object not found\n"); 2404c3362f4SHans de Goede return ERR_PTR(-ENODEV); 2414c3362f4SHans de Goede } 2424c3362f4SHans de Goede 2434c3362f4SHans de Goede /* Look for the Button Descriptors UUID */ 2444c3362f4SHans de Goede desc = buf.pointer; 2454c3362f4SHans de Goede for (i = 0; (i + 1) < desc->package.count; i += 2) { 2464c3362f4SHans de Goede uuid = &desc->package.elements[i]; 2474c3362f4SHans de Goede 2484c3362f4SHans de Goede if (uuid->type != ACPI_TYPE_BUFFER || 2494c3362f4SHans de Goede uuid->buffer.length != 16 || 2504c3362f4SHans de Goede desc->package.elements[i + 1].type != ACPI_TYPE_PACKAGE) { 2514c3362f4SHans de Goede break; 2524c3362f4SHans de Goede } 2534c3362f4SHans de Goede 2544c3362f4SHans de Goede if (memcmp(uuid->buffer.pointer, btns_desc_uuid, 16) == 0) { 2554c3362f4SHans de Goede btns_desc = &desc->package.elements[i + 1]; 2564c3362f4SHans de Goede break; 2574c3362f4SHans de Goede } 2584c3362f4SHans de Goede } 2594c3362f4SHans de Goede 2604c3362f4SHans de Goede if (!btns_desc) { 2614c3362f4SHans de Goede dev_err(dev, "ACPI Button Descriptors not found\n"); 262779f19acSHans de Goede button_info = ERR_PTR(-ENODEV); 263779f19acSHans de Goede goto out; 2644c3362f4SHans de Goede } 2654c3362f4SHans de Goede 2664c3362f4SHans de Goede /* The first package describes the collection */ 2674c3362f4SHans de Goede el0 = &btns_desc->package.elements[0]; 2684c3362f4SHans de Goede if (el0->type == ACPI_TYPE_PACKAGE && 2694c3362f4SHans de Goede el0->package.count == 5 && 2704c3362f4SHans de Goede /* First byte should be 0 (collection) */ 2714c3362f4SHans de Goede soc_button_get_acpi_object_int(&el0->package.elements[0]) == 0 && 2724c3362f4SHans de Goede /* Third byte should be 0 (top level collection) */ 2734c3362f4SHans de Goede soc_button_get_acpi_object_int(&el0->package.elements[2]) == 0) { 2744c3362f4SHans de Goede collection_uid = soc_button_get_acpi_object_int( 2754c3362f4SHans de Goede &el0->package.elements[1]); 2764c3362f4SHans de Goede } 2774c3362f4SHans de Goede if (collection_uid == -1) { 2784c3362f4SHans de Goede dev_err(dev, "Invalid Button Collection Descriptor\n"); 279779f19acSHans de Goede button_info = ERR_PTR(-ENODEV); 280779f19acSHans de Goede goto out; 2814c3362f4SHans de Goede } 2824c3362f4SHans de Goede 2834c3362f4SHans de Goede /* There are package.count - 1 buttons + 1 terminating empty entry */ 2844c3362f4SHans de Goede button_info = devm_kcalloc(dev, btns_desc->package.count, 2854c3362f4SHans de Goede sizeof(*button_info), GFP_KERNEL); 286779f19acSHans de Goede if (!button_info) { 287779f19acSHans de Goede button_info = ERR_PTR(-ENOMEM); 288779f19acSHans de Goede goto out; 289779f19acSHans de Goede } 2904c3362f4SHans de Goede 2914c3362f4SHans de Goede /* Parse the button descriptors */ 2924c3362f4SHans de Goede for (i = 1, btn = 0; i < btns_desc->package.count; i++, btn++) { 2934c3362f4SHans de Goede if (soc_button_parse_btn_desc(dev, 2944c3362f4SHans de Goede &btns_desc->package.elements[i], 2954c3362f4SHans de Goede collection_uid, 296779f19acSHans de Goede &button_info[btn])) { 297779f19acSHans de Goede button_info = ERR_PTR(-ENODEV); 298779f19acSHans de Goede goto out; 299779f19acSHans de Goede } 3004c3362f4SHans de Goede } 3014c3362f4SHans de Goede 302779f19acSHans de Goede out: 303779f19acSHans de Goede kfree(buf.pointer); 3044c3362f4SHans de Goede return button_info; 3054c3362f4SHans de Goede } 3064c3362f4SHans de Goede 307042e1c79SJin Yao static int soc_button_remove(struct platform_device *pdev) 30861cd4822SLejun Zhu { 309042e1c79SJin Yao struct soc_button_data *priv = platform_get_drvdata(pdev); 310042e1c79SJin Yao 31161cd4822SLejun Zhu int i; 31261cd4822SLejun Zhu 31361cd4822SLejun Zhu for (i = 0; i < BUTTON_TYPES; i++) 31461cd4822SLejun Zhu if (priv->children[i]) 31561cd4822SLejun Zhu platform_device_unregister(priv->children[i]); 316042e1c79SJin Yao 317042e1c79SJin Yao return 0; 31861cd4822SLejun Zhu } 31961cd4822SLejun Zhu 320042e1c79SJin Yao static int soc_button_probe(struct platform_device *pdev) 32161cd4822SLejun Zhu { 322042e1c79SJin Yao struct device *dev = &pdev->dev; 323c3941593SMaximilian Luz const struct soc_device_data *device_data; 324c3941593SMaximilian Luz const struct soc_button_info *button_info; 32561cd4822SLejun Zhu struct soc_button_data *priv; 32661cd4822SLejun Zhu struct platform_device *pd; 32761cd4822SLejun Zhu int i; 32861cd4822SLejun Zhu int error; 32961cd4822SLejun Zhu 330c3941593SMaximilian Luz device_data = acpi_device_get_match_data(dev); 331c3941593SMaximilian Luz if (device_data && device_data->check) { 332c3941593SMaximilian Luz error = device_data->check(dev); 333c3941593SMaximilian Luz if (error) 334c3941593SMaximilian Luz return error; 335c3941593SMaximilian Luz } 336042e1c79SJin Yao 337c3941593SMaximilian Luz if (device_data && device_data->button_info) { 338c3941593SMaximilian Luz button_info = device_data->button_info; 339c3941593SMaximilian Luz } else { 3404c3362f4SHans de Goede button_info = soc_button_get_button_info(dev); 3414c3362f4SHans de Goede if (IS_ERR(button_info)) 3424c3362f4SHans de Goede return PTR_ERR(button_info); 3434c3362f4SHans de Goede } 344042e1c79SJin Yao 345c5097538SAndy Shevchenko error = gpiod_count(dev, NULL); 346c5097538SAndy Shevchenko if (error < 0) { 347aa45590aSGuenter Roeck dev_dbg(dev, "no GPIO attached, ignoring...\n"); 348d912366aSHans de Goede return -ENODEV; 3493d5a9437SBenjamin Tissoires } 3503d5a9437SBenjamin Tissoires 351aa45590aSGuenter Roeck priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL); 35261cd4822SLejun Zhu if (!priv) 35361cd4822SLejun Zhu return -ENOMEM; 35461cd4822SLejun Zhu 355042e1c79SJin Yao platform_set_drvdata(pdev, priv); 35661cd4822SLejun Zhu 35761cd4822SLejun Zhu for (i = 0; i < BUTTON_TYPES; i++) { 35861cd4822SLejun Zhu pd = soc_button_device_create(pdev, button_info, i == 0); 35961cd4822SLejun Zhu if (IS_ERR(pd)) { 36061cd4822SLejun Zhu error = PTR_ERR(pd); 36161cd4822SLejun Zhu if (error != -ENODEV) { 36261cd4822SLejun Zhu soc_button_remove(pdev); 36361cd4822SLejun Zhu return error; 36461cd4822SLejun Zhu } 3657740fc52SLejun Zhu continue; 36661cd4822SLejun Zhu } 36761cd4822SLejun Zhu 36861cd4822SLejun Zhu priv->children[i] = pd; 36961cd4822SLejun Zhu } 37061cd4822SLejun Zhu 37161cd4822SLejun Zhu if (!priv->children[0] && !priv->children[1]) 37261cd4822SLejun Zhu return -ENODEV; 37361cd4822SLejun Zhu 374c3941593SMaximilian Luz if (!device_data || !device_data->button_info) 3754c3362f4SHans de Goede devm_kfree(dev, button_info); 3764c3362f4SHans de Goede 37761cd4822SLejun Zhu return 0; 37861cd4822SLejun Zhu } 37961cd4822SLejun Zhu 3807283b47dSHans de Goede /* 3817283b47dSHans de Goede * Definition of buttons on the tablet. The ACPI index of each button 3827283b47dSHans de Goede * is defined in section 2.8.7.2 of "Windows ACPI Design Guide for SoC 3837283b47dSHans de Goede * Platforms" 3847283b47dSHans de Goede */ 385c3941593SMaximilian Luz static const struct soc_button_info soc_button_PNP0C40[] = { 38661cd4822SLejun Zhu { "power", 0, EV_KEY, KEY_POWER, false, true }, 387791738beSBastien Nocera { "home", 1, EV_KEY, KEY_LEFTMETA, false, true }, 38861cd4822SLejun Zhu { "volume_up", 2, EV_KEY, KEY_VOLUMEUP, true, false }, 38961cd4822SLejun Zhu { "volume_down", 3, EV_KEY, KEY_VOLUMEDOWN, true, false }, 390e9eb788fSHans de Goede { "rotation_lock", 4, EV_KEY, KEY_ROTATE_LOCK_TOGGLE, false, false }, 39161cd4822SLejun Zhu { } 39261cd4822SLejun Zhu }; 39361cd4822SLejun Zhu 394c3941593SMaximilian Luz static const struct soc_device_data soc_device_PNP0C40 = { 395c3941593SMaximilian Luz .button_info = soc_button_PNP0C40, 396c3941593SMaximilian Luz }; 397c3941593SMaximilian Luz 398c3941593SMaximilian Luz /* 399c3941593SMaximilian Luz * Special device check for Surface Book 2 and Surface Pro (2017). 400c3941593SMaximilian Luz * Both, the Surface Pro 4 (surfacepro3_button.c) and the above mentioned 401c3941593SMaximilian Luz * devices use MSHW0040 for power and volume buttons, however the way they 402c3941593SMaximilian Luz * have to be addressed differs. Make sure that we only load this drivers 403c3941593SMaximilian Luz * for the correct devices by checking the OEM Platform Revision provided by 404c3941593SMaximilian Luz * the _DSM method. 405c3941593SMaximilian Luz */ 406c3941593SMaximilian Luz #define MSHW0040_DSM_REVISION 0x01 407c3941593SMaximilian Luz #define MSHW0040_DSM_GET_OMPR 0x02 // get OEM Platform Revision 408c3941593SMaximilian Luz static const guid_t MSHW0040_DSM_UUID = 409c3941593SMaximilian Luz GUID_INIT(0x6fd05c69, 0xcde3, 0x49f4, 0x95, 0xed, 0xab, 0x16, 0x65, 410c3941593SMaximilian Luz 0x49, 0x80, 0x35); 411c3941593SMaximilian Luz 412c3941593SMaximilian Luz static int soc_device_check_MSHW0040(struct device *dev) 413c3941593SMaximilian Luz { 414c3941593SMaximilian Luz acpi_handle handle = ACPI_HANDLE(dev); 415c3941593SMaximilian Luz union acpi_object *result; 416c3941593SMaximilian Luz u64 oem_platform_rev = 0; // valid revisions are nonzero 417c3941593SMaximilian Luz 418c3941593SMaximilian Luz // get OEM platform revision 419c3941593SMaximilian Luz result = acpi_evaluate_dsm_typed(handle, &MSHW0040_DSM_UUID, 420c3941593SMaximilian Luz MSHW0040_DSM_REVISION, 421c3941593SMaximilian Luz MSHW0040_DSM_GET_OMPR, NULL, 422c3941593SMaximilian Luz ACPI_TYPE_INTEGER); 423c3941593SMaximilian Luz 424c3941593SMaximilian Luz if (result) { 425c3941593SMaximilian Luz oem_platform_rev = result->integer.value; 426c3941593SMaximilian Luz ACPI_FREE(result); 427c3941593SMaximilian Luz } 428c3941593SMaximilian Luz 429c3941593SMaximilian Luz /* 430c3941593SMaximilian Luz * If the revision is zero here, the _DSM evaluation has failed. This 431c3941593SMaximilian Luz * indicates that we have a Pro 4 or Book 1 and this driver should not 432c3941593SMaximilian Luz * be used. 433c3941593SMaximilian Luz */ 434c3941593SMaximilian Luz if (oem_platform_rev == 0) 435c3941593SMaximilian Luz return -ENODEV; 436c3941593SMaximilian Luz 437c3941593SMaximilian Luz dev_dbg(dev, "OEM Platform Revision %llu\n", oem_platform_rev); 438c3941593SMaximilian Luz 439c3941593SMaximilian Luz return 0; 440c3941593SMaximilian Luz } 441c3941593SMaximilian Luz 442c3941593SMaximilian Luz /* 443c3941593SMaximilian Luz * Button infos for Microsoft Surface Book 2 and Surface Pro (2017). 444c3941593SMaximilian Luz * Obtained from DSDT/testing. 445c3941593SMaximilian Luz */ 446c3941593SMaximilian Luz static const struct soc_button_info soc_button_MSHW0040[] = { 447c3941593SMaximilian Luz { "power", 0, EV_KEY, KEY_POWER, false, true }, 448c3941593SMaximilian Luz { "volume_up", 2, EV_KEY, KEY_VOLUMEUP, true, false }, 449c3941593SMaximilian Luz { "volume_down", 4, EV_KEY, KEY_VOLUMEDOWN, true, false }, 450c3941593SMaximilian Luz { } 451c3941593SMaximilian Luz }; 452c3941593SMaximilian Luz 453c3941593SMaximilian Luz static const struct soc_device_data soc_device_MSHW0040 = { 454c3941593SMaximilian Luz .button_info = soc_button_MSHW0040, 455c3941593SMaximilian Luz .check = soc_device_check_MSHW0040, 456c3941593SMaximilian Luz }; 457c3941593SMaximilian Luz 458042e1c79SJin Yao static const struct acpi_device_id soc_button_acpi_match[] = { 459c3941593SMaximilian Luz { "PNP0C40", (unsigned long)&soc_device_PNP0C40 }, 4604c3362f4SHans de Goede { "ACPI0011", 0 }, 461c3941593SMaximilian Luz 462c3941593SMaximilian Luz /* Microsoft Surface Devices (5th and 6th generation) */ 463c3941593SMaximilian Luz { "MSHW0040", (unsigned long)&soc_device_MSHW0040 }, 464c3941593SMaximilian Luz 465042e1c79SJin Yao { } 46661cd4822SLejun Zhu }; 46761cd4822SLejun Zhu 468042e1c79SJin Yao MODULE_DEVICE_TABLE(acpi, soc_button_acpi_match); 469042e1c79SJin Yao 470042e1c79SJin Yao static struct platform_driver soc_button_driver = { 471042e1c79SJin Yao .probe = soc_button_probe, 47261cd4822SLejun Zhu .remove = soc_button_remove, 473042e1c79SJin Yao .driver = { 474042e1c79SJin Yao .name = KBUILD_MODNAME, 475042e1c79SJin Yao .acpi_match_table = ACPI_PTR(soc_button_acpi_match), 476042e1c79SJin Yao }, 47761cd4822SLejun Zhu }; 478042e1c79SJin Yao module_platform_driver(soc_button_driver); 47961cd4822SLejun Zhu 48061cd4822SLejun Zhu MODULE_LICENSE("GPL"); 481