1411269baSMaximilian Luz // SPDX-License-Identifier: GPL-2.0-only
2411269baSMaximilian Luz /*
3411269baSMaximilian Luz * power/home/volume button support for
4411269baSMaximilian Luz * Microsoft Surface Pro 3/4 tablet.
5411269baSMaximilian Luz *
6411269baSMaximilian Luz * Copyright (c) 2015 Intel Corporation.
7411269baSMaximilian Luz * All rights reserved.
8411269baSMaximilian Luz */
9411269baSMaximilian Luz
10411269baSMaximilian Luz #include <linux/kernel.h>
11411269baSMaximilian Luz #include <linux/module.h>
12411269baSMaximilian Luz #include <linux/init.h>
13411269baSMaximilian Luz #include <linux/types.h>
14411269baSMaximilian Luz #include <linux/input.h>
15411269baSMaximilian Luz #include <linux/acpi.h>
16411269baSMaximilian Luz #include <acpi/button.h>
17411269baSMaximilian Luz
18411269baSMaximilian Luz #define SURFACE_PRO3_BUTTON_HID "MSHW0028"
19411269baSMaximilian Luz #define SURFACE_PRO4_BUTTON_HID "MSHW0040"
20411269baSMaximilian Luz #define SURFACE_BUTTON_OBJ_NAME "VGBI"
21411269baSMaximilian Luz #define SURFACE_BUTTON_DEVICE_NAME "Surface Pro 3/4 Buttons"
22411269baSMaximilian Luz
23411269baSMaximilian Luz #define MSHW0040_DSM_REVISION 0x01
24411269baSMaximilian Luz #define MSHW0040_DSM_GET_OMPR 0x02 // get OEM Platform Revision
25411269baSMaximilian Luz static const guid_t MSHW0040_DSM_UUID =
26411269baSMaximilian Luz GUID_INIT(0x6fd05c69, 0xcde3, 0x49f4, 0x95, 0xed, 0xab, 0x16, 0x65,
27411269baSMaximilian Luz 0x49, 0x80, 0x35);
28411269baSMaximilian Luz
29411269baSMaximilian Luz #define SURFACE_BUTTON_NOTIFY_TABLET_MODE 0xc8
30411269baSMaximilian Luz
31411269baSMaximilian Luz #define SURFACE_BUTTON_NOTIFY_PRESS_POWER 0xc6
32411269baSMaximilian Luz #define SURFACE_BUTTON_NOTIFY_RELEASE_POWER 0xc7
33411269baSMaximilian Luz
34411269baSMaximilian Luz #define SURFACE_BUTTON_NOTIFY_PRESS_HOME 0xc4
35411269baSMaximilian Luz #define SURFACE_BUTTON_NOTIFY_RELEASE_HOME 0xc5
36411269baSMaximilian Luz
37411269baSMaximilian Luz #define SURFACE_BUTTON_NOTIFY_PRESS_VOLUME_UP 0xc0
38411269baSMaximilian Luz #define SURFACE_BUTTON_NOTIFY_RELEASE_VOLUME_UP 0xc1
39411269baSMaximilian Luz
40411269baSMaximilian Luz #define SURFACE_BUTTON_NOTIFY_PRESS_VOLUME_DOWN 0xc2
41411269baSMaximilian Luz #define SURFACE_BUTTON_NOTIFY_RELEASE_VOLUME_DOWN 0xc3
42411269baSMaximilian Luz
43411269baSMaximilian Luz MODULE_AUTHOR("Chen Yu");
44411269baSMaximilian Luz MODULE_DESCRIPTION("Surface Pro3 Button Driver");
45411269baSMaximilian Luz MODULE_LICENSE("GPL v2");
46411269baSMaximilian Luz
47411269baSMaximilian Luz /*
48411269baSMaximilian Luz * Power button, Home button, Volume buttons support is supposed to
49411269baSMaximilian Luz * be covered by drivers/input/misc/soc_button_array.c, which is implemented
50411269baSMaximilian Luz * according to "Windows ACPI Design Guide for SoC Platforms".
51411269baSMaximilian Luz * However surface pro3 seems not to obey the specs, instead it uses
52411269baSMaximilian Luz * device VGBI(MSHW0028) for dispatching the events.
53411269baSMaximilian Luz * We choose acpi_driver rather than platform_driver/i2c_driver because
54411269baSMaximilian Luz * although VGBI has an i2c resource connected to i2c controller, it
55411269baSMaximilian Luz * is not embedded in any i2c controller's scope, thus neither platform_device
56411269baSMaximilian Luz * will be created, nor i2c_client will be enumerated, we have to use
57411269baSMaximilian Luz * acpi_driver.
58411269baSMaximilian Luz */
59411269baSMaximilian Luz static const struct acpi_device_id surface_button_device_ids[] = {
60411269baSMaximilian Luz {SURFACE_PRO3_BUTTON_HID, 0},
61411269baSMaximilian Luz {SURFACE_PRO4_BUTTON_HID, 0},
62411269baSMaximilian Luz {"", 0},
63411269baSMaximilian Luz };
64411269baSMaximilian Luz MODULE_DEVICE_TABLE(acpi, surface_button_device_ids);
65411269baSMaximilian Luz
66411269baSMaximilian Luz struct surface_button {
67411269baSMaximilian Luz unsigned int type;
68411269baSMaximilian Luz struct input_dev *input;
69411269baSMaximilian Luz char phys[32]; /* for input device */
70411269baSMaximilian Luz unsigned long pushed;
71411269baSMaximilian Luz bool suspended;
72411269baSMaximilian Luz };
73411269baSMaximilian Luz
surface_button_notify(struct acpi_device * device,u32 event)74411269baSMaximilian Luz static void surface_button_notify(struct acpi_device *device, u32 event)
75411269baSMaximilian Luz {
76411269baSMaximilian Luz struct surface_button *button = acpi_driver_data(device);
77411269baSMaximilian Luz struct input_dev *input;
78411269baSMaximilian Luz int key_code = KEY_RESERVED;
79411269baSMaximilian Luz bool pressed = false;
80411269baSMaximilian Luz
81411269baSMaximilian Luz switch (event) {
82411269baSMaximilian Luz /* Power button press,release handle */
83411269baSMaximilian Luz case SURFACE_BUTTON_NOTIFY_PRESS_POWER:
84411269baSMaximilian Luz pressed = true;
85411269baSMaximilian Luz fallthrough;
86411269baSMaximilian Luz case SURFACE_BUTTON_NOTIFY_RELEASE_POWER:
87411269baSMaximilian Luz key_code = KEY_POWER;
88411269baSMaximilian Luz break;
89411269baSMaximilian Luz /* Home button press,release handle */
90411269baSMaximilian Luz case SURFACE_BUTTON_NOTIFY_PRESS_HOME:
91411269baSMaximilian Luz pressed = true;
92411269baSMaximilian Luz fallthrough;
93411269baSMaximilian Luz case SURFACE_BUTTON_NOTIFY_RELEASE_HOME:
94411269baSMaximilian Luz key_code = KEY_LEFTMETA;
95411269baSMaximilian Luz break;
96411269baSMaximilian Luz /* Volume up button press,release handle */
97411269baSMaximilian Luz case SURFACE_BUTTON_NOTIFY_PRESS_VOLUME_UP:
98411269baSMaximilian Luz pressed = true;
99411269baSMaximilian Luz fallthrough;
100411269baSMaximilian Luz case SURFACE_BUTTON_NOTIFY_RELEASE_VOLUME_UP:
101411269baSMaximilian Luz key_code = KEY_VOLUMEUP;
102411269baSMaximilian Luz break;
103411269baSMaximilian Luz /* Volume down button press,release handle */
104411269baSMaximilian Luz case SURFACE_BUTTON_NOTIFY_PRESS_VOLUME_DOWN:
105411269baSMaximilian Luz pressed = true;
106411269baSMaximilian Luz fallthrough;
107411269baSMaximilian Luz case SURFACE_BUTTON_NOTIFY_RELEASE_VOLUME_DOWN:
108411269baSMaximilian Luz key_code = KEY_VOLUMEDOWN;
109411269baSMaximilian Luz break;
110411269baSMaximilian Luz case SURFACE_BUTTON_NOTIFY_TABLET_MODE:
111411269baSMaximilian Luz dev_warn_once(&device->dev, "Tablet mode is not supported\n");
112411269baSMaximilian Luz break;
113411269baSMaximilian Luz default:
114411269baSMaximilian Luz dev_info_ratelimited(&device->dev,
115411269baSMaximilian Luz "Unsupported event [0x%x]\n", event);
116411269baSMaximilian Luz break;
117411269baSMaximilian Luz }
118411269baSMaximilian Luz input = button->input;
119411269baSMaximilian Luz if (key_code == KEY_RESERVED)
120411269baSMaximilian Luz return;
121411269baSMaximilian Luz if (pressed)
122411269baSMaximilian Luz pm_wakeup_dev_event(&device->dev, 0, button->suspended);
123411269baSMaximilian Luz if (button->suspended)
124411269baSMaximilian Luz return;
125411269baSMaximilian Luz input_report_key(input, key_code, pressed?1:0);
126411269baSMaximilian Luz input_sync(input);
127411269baSMaximilian Luz }
128411269baSMaximilian Luz
129411269baSMaximilian Luz #ifdef CONFIG_PM_SLEEP
surface_button_suspend(struct device * dev)130411269baSMaximilian Luz static int surface_button_suspend(struct device *dev)
131411269baSMaximilian Luz {
132411269baSMaximilian Luz struct acpi_device *device = to_acpi_device(dev);
133411269baSMaximilian Luz struct surface_button *button = acpi_driver_data(device);
134411269baSMaximilian Luz
135411269baSMaximilian Luz button->suspended = true;
136411269baSMaximilian Luz return 0;
137411269baSMaximilian Luz }
138411269baSMaximilian Luz
surface_button_resume(struct device * dev)139411269baSMaximilian Luz static int surface_button_resume(struct device *dev)
140411269baSMaximilian Luz {
141411269baSMaximilian Luz struct acpi_device *device = to_acpi_device(dev);
142411269baSMaximilian Luz struct surface_button *button = acpi_driver_data(device);
143411269baSMaximilian Luz
144411269baSMaximilian Luz button->suspended = false;
145411269baSMaximilian Luz return 0;
146411269baSMaximilian Luz }
147411269baSMaximilian Luz #endif
148411269baSMaximilian Luz
149411269baSMaximilian Luz /*
150411269baSMaximilian Luz * Surface Pro 4 and Surface Book 2 / Surface Pro 2017 use the same device
151411269baSMaximilian Luz * ID (MSHW0040) for the power/volume buttons. Make sure this is the right
152411269baSMaximilian Luz * device by checking for the _DSM method and OEM Platform Revision.
153411269baSMaximilian Luz *
154411269baSMaximilian Luz * Returns true if the driver should bind to this device, i.e. the device is
155411269baSMaximilian Luz * either MSWH0028 (Pro 3) or MSHW0040 on a Pro 4 or Book 1.
156411269baSMaximilian Luz */
surface_button_check_MSHW0040(struct acpi_device * dev)157411269baSMaximilian Luz static bool surface_button_check_MSHW0040(struct acpi_device *dev)
158411269baSMaximilian Luz {
159411269baSMaximilian Luz acpi_handle handle = dev->handle;
160411269baSMaximilian Luz union acpi_object *result;
161411269baSMaximilian Luz u64 oem_platform_rev = 0; // valid revisions are nonzero
162411269baSMaximilian Luz
163411269baSMaximilian Luz // get OEM platform revision
164411269baSMaximilian Luz result = acpi_evaluate_dsm_typed(handle, &MSHW0040_DSM_UUID,
165411269baSMaximilian Luz MSHW0040_DSM_REVISION,
166411269baSMaximilian Luz MSHW0040_DSM_GET_OMPR,
167411269baSMaximilian Luz NULL, ACPI_TYPE_INTEGER);
168411269baSMaximilian Luz
169411269baSMaximilian Luz /*
170411269baSMaximilian Luz * If evaluating the _DSM fails, the method is not present. This means
171411269baSMaximilian Luz * that we have either MSHW0028 or MSHW0040 on Pro 4 or Book 1, so we
172411269baSMaximilian Luz * should use this driver. We use revision 0 indicating it is
173411269baSMaximilian Luz * unavailable.
174411269baSMaximilian Luz */
175411269baSMaximilian Luz
176411269baSMaximilian Luz if (result) {
177411269baSMaximilian Luz oem_platform_rev = result->integer.value;
178411269baSMaximilian Luz ACPI_FREE(result);
179411269baSMaximilian Luz }
180411269baSMaximilian Luz
181411269baSMaximilian Luz dev_dbg(&dev->dev, "OEM Platform Revision %llu\n", oem_platform_rev);
182411269baSMaximilian Luz
183411269baSMaximilian Luz return oem_platform_rev == 0;
184411269baSMaximilian Luz }
185411269baSMaximilian Luz
186411269baSMaximilian Luz
surface_button_add(struct acpi_device * device)187411269baSMaximilian Luz static int surface_button_add(struct acpi_device *device)
188411269baSMaximilian Luz {
189411269baSMaximilian Luz struct surface_button *button;
190411269baSMaximilian Luz struct input_dev *input;
191411269baSMaximilian Luz const char *hid = acpi_device_hid(device);
192411269baSMaximilian Luz char *name;
193411269baSMaximilian Luz int error;
194411269baSMaximilian Luz
195411269baSMaximilian Luz if (strncmp(acpi_device_bid(device), SURFACE_BUTTON_OBJ_NAME,
196411269baSMaximilian Luz strlen(SURFACE_BUTTON_OBJ_NAME)))
197411269baSMaximilian Luz return -ENODEV;
198411269baSMaximilian Luz
199411269baSMaximilian Luz if (!surface_button_check_MSHW0040(device))
200411269baSMaximilian Luz return -ENODEV;
201411269baSMaximilian Luz
202411269baSMaximilian Luz button = kzalloc(sizeof(struct surface_button), GFP_KERNEL);
203411269baSMaximilian Luz if (!button)
204411269baSMaximilian Luz return -ENOMEM;
205411269baSMaximilian Luz
206411269baSMaximilian Luz device->driver_data = button;
207411269baSMaximilian Luz button->input = input = input_allocate_device();
208411269baSMaximilian Luz if (!input) {
209411269baSMaximilian Luz error = -ENOMEM;
210411269baSMaximilian Luz goto err_free_button;
211411269baSMaximilian Luz }
212411269baSMaximilian Luz
213411269baSMaximilian Luz name = acpi_device_name(device);
214411269baSMaximilian Luz strcpy(name, SURFACE_BUTTON_DEVICE_NAME);
215411269baSMaximilian Luz snprintf(button->phys, sizeof(button->phys), "%s/buttons", hid);
216411269baSMaximilian Luz
217411269baSMaximilian Luz input->name = name;
218411269baSMaximilian Luz input->phys = button->phys;
219411269baSMaximilian Luz input->id.bustype = BUS_HOST;
220411269baSMaximilian Luz input->dev.parent = &device->dev;
221411269baSMaximilian Luz input_set_capability(input, EV_KEY, KEY_POWER);
222411269baSMaximilian Luz input_set_capability(input, EV_KEY, KEY_LEFTMETA);
223411269baSMaximilian Luz input_set_capability(input, EV_KEY, KEY_VOLUMEUP);
224411269baSMaximilian Luz input_set_capability(input, EV_KEY, KEY_VOLUMEDOWN);
225411269baSMaximilian Luz
226411269baSMaximilian Luz error = input_register_device(input);
227411269baSMaximilian Luz if (error)
228411269baSMaximilian Luz goto err_free_input;
229411269baSMaximilian Luz
230411269baSMaximilian Luz device_init_wakeup(&device->dev, true);
231411269baSMaximilian Luz dev_info(&device->dev,
232411269baSMaximilian Luz "%s [%s]\n", name, acpi_device_bid(device));
233411269baSMaximilian Luz return 0;
234411269baSMaximilian Luz
235411269baSMaximilian Luz err_free_input:
236411269baSMaximilian Luz input_free_device(input);
237411269baSMaximilian Luz err_free_button:
238411269baSMaximilian Luz kfree(button);
239411269baSMaximilian Luz return error;
240411269baSMaximilian Luz }
241411269baSMaximilian Luz
surface_button_remove(struct acpi_device * device)242*6c0eb5baSDawei Li static void surface_button_remove(struct acpi_device *device)
243411269baSMaximilian Luz {
244411269baSMaximilian Luz struct surface_button *button = acpi_driver_data(device);
245411269baSMaximilian Luz
246411269baSMaximilian Luz input_unregister_device(button->input);
247411269baSMaximilian Luz kfree(button);
248411269baSMaximilian Luz }
249411269baSMaximilian Luz
250411269baSMaximilian Luz static SIMPLE_DEV_PM_OPS(surface_button_pm,
251411269baSMaximilian Luz surface_button_suspend, surface_button_resume);
252411269baSMaximilian Luz
253411269baSMaximilian Luz static struct acpi_driver surface_button_driver = {
254411269baSMaximilian Luz .name = "surface_pro3_button",
255411269baSMaximilian Luz .class = "SurfacePro3",
256411269baSMaximilian Luz .ids = surface_button_device_ids,
257411269baSMaximilian Luz .ops = {
258411269baSMaximilian Luz .add = surface_button_add,
259411269baSMaximilian Luz .remove = surface_button_remove,
260411269baSMaximilian Luz .notify = surface_button_notify,
261411269baSMaximilian Luz },
262411269baSMaximilian Luz .drv.pm = &surface_button_pm,
263411269baSMaximilian Luz };
264411269baSMaximilian Luz
265411269baSMaximilian Luz module_acpi_driver(surface_button_driver);
266