1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Surface GPE/Lid driver to enable wakeup from suspend via the lid by
4 * properly configuring the respective GPEs. Required for wakeup via lid on
5 * newer Intel-based Microsoft Surface devices.
7 * Copyright (C) 2020 Maximilian Luz <luzmaximilian@gmail.com>
10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12 #include <linux/acpi.h>
13 #include <linux/dmi.h>
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/platform_device.h>
19 * Note: The GPE numbers for the lid devices found below have been obtained
20 * from ACPI/the DSDT table, specifically from the GPE handler for the
24 static const struct property_entry lid_device_props_l17[] = {
25 PROPERTY_ENTRY_U32("gpe", 0x17),
29 static const struct property_entry lid_device_props_l4B[] = {
30 PROPERTY_ENTRY_U32("gpe", 0x4B),
34 static const struct property_entry lid_device_props_l4D[] = {
35 PROPERTY_ENTRY_U32("gpe", 0x4D),
39 static const struct property_entry lid_device_props_l4F[] = {
40 PROPERTY_ENTRY_U32("gpe", 0x4F),
44 static const struct property_entry lid_device_props_l57[] = {
45 PROPERTY_ENTRY_U32("gpe", 0x57),
50 * Note: When changing this, don't forget to check that the MODULE_ALIAS below
53 static const struct dmi_system_id dmi_lid_device_table[] = {
55 .ident = "Surface Pro 4",
57 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
58 DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Pro 4"),
60 .driver_data = (void *)lid_device_props_l17,
63 .ident = "Surface Pro 5",
66 * We match for SKU here due to generic product name
69 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
70 DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "Surface_Pro_1796"),
72 .driver_data = (void *)lid_device_props_l4F,
75 .ident = "Surface Pro 5 (LTE)",
78 * We match for SKU here due to generic product name
81 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
82 DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "Surface_Pro_1807"),
84 .driver_data = (void *)lid_device_props_l4F,
87 .ident = "Surface Pro 6",
89 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
90 DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Pro 6"),
92 .driver_data = (void *)lid_device_props_l4F,
95 .ident = "Surface Pro 7",
97 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
98 DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Pro 7"),
100 .driver_data = (void *)lid_device_props_l4D,
103 .ident = "Surface Pro 8",
105 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
106 DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Pro 8"),
108 .driver_data = (void *)lid_device_props_l4B,
111 .ident = "Surface Book 1",
113 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
114 DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Book"),
116 .driver_data = (void *)lid_device_props_l17,
119 .ident = "Surface Book 2",
121 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
122 DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Book 2"),
124 .driver_data = (void *)lid_device_props_l17,
127 .ident = "Surface Book 3",
129 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
130 DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Book 3"),
132 .driver_data = (void *)lid_device_props_l4D,
135 .ident = "Surface Laptop 1",
137 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
138 DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Laptop"),
140 .driver_data = (void *)lid_device_props_l57,
143 .ident = "Surface Laptop 2",
145 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
146 DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Laptop 2"),
148 .driver_data = (void *)lid_device_props_l57,
151 .ident = "Surface Laptop 3 (Intel 13\")",
154 * We match for SKU here due to different variants: The
155 * AMD (15") version does not rely on GPEs.
157 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
158 DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "Surface_Laptop_3_1867:1868"),
160 .driver_data = (void *)lid_device_props_l4D,
163 .ident = "Surface Laptop 3 (Intel 15\")",
166 * We match for SKU here due to different variants: The
167 * AMD (15") version does not rely on GPEs.
169 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
170 DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "Surface_Laptop_3_1872"),
172 .driver_data = (void *)lid_device_props_l4D,
175 .ident = "Surface Laptop Studio",
177 DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
178 DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Laptop Studio"),
180 .driver_data = (void *)lid_device_props_l4B,
185 struct surface_lid_device {
189 static int surface_lid_enable_wakeup(struct device *dev, bool enable)
191 const struct surface_lid_device *lid = dev_get_drvdata(dev);
192 int action = enable ? ACPI_GPE_ENABLE : ACPI_GPE_DISABLE;
195 status = acpi_set_gpe_wake_mask(NULL, lid->gpe_number, action);
196 if (ACPI_FAILURE(status)) {
197 dev_err(dev, "failed to set GPE wake mask: %s\n",
198 acpi_format_exception(status));
205 static int __maybe_unused surface_gpe_suspend(struct device *dev)
207 return surface_lid_enable_wakeup(dev, true);
210 static int __maybe_unused surface_gpe_resume(struct device *dev)
212 return surface_lid_enable_wakeup(dev, false);
215 static SIMPLE_DEV_PM_OPS(surface_gpe_pm, surface_gpe_suspend, surface_gpe_resume);
217 static int surface_gpe_probe(struct platform_device *pdev)
219 struct surface_lid_device *lid;
224 ret = device_property_read_u32(&pdev->dev, "gpe", &gpe_number);
226 dev_err(&pdev->dev, "failed to read 'gpe' property: %d\n", ret);
230 lid = devm_kzalloc(&pdev->dev, sizeof(*lid), GFP_KERNEL);
234 lid->gpe_number = gpe_number;
235 platform_set_drvdata(pdev, lid);
237 status = acpi_mark_gpe_for_wake(NULL, gpe_number);
238 if (ACPI_FAILURE(status)) {
239 dev_err(&pdev->dev, "failed to mark GPE for wake: %s\n",
240 acpi_format_exception(status));
244 status = acpi_enable_gpe(NULL, gpe_number);
245 if (ACPI_FAILURE(status)) {
246 dev_err(&pdev->dev, "failed to enable GPE: %s\n",
247 acpi_format_exception(status));
251 ret = surface_lid_enable_wakeup(&pdev->dev, false);
253 acpi_disable_gpe(NULL, gpe_number);
258 static int surface_gpe_remove(struct platform_device *pdev)
260 struct surface_lid_device *lid = dev_get_drvdata(&pdev->dev);
262 /* restore default behavior without this module */
263 surface_lid_enable_wakeup(&pdev->dev, false);
264 acpi_disable_gpe(NULL, lid->gpe_number);
269 static struct platform_driver surface_gpe_driver = {
270 .probe = surface_gpe_probe,
271 .remove = surface_gpe_remove,
273 .name = "surface_gpe",
274 .pm = &surface_gpe_pm,
275 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
279 static struct platform_device *surface_gpe_device;
281 static int __init surface_gpe_init(void)
283 const struct dmi_system_id *match;
284 struct platform_device *pdev;
285 struct fwnode_handle *fwnode;
288 match = dmi_first_match(dmi_lid_device_table);
290 pr_info("no compatible Microsoft Surface device found, exiting\n");
294 status = platform_driver_register(&surface_gpe_driver);
298 fwnode = fwnode_create_software_node(match->driver_data, NULL);
299 if (IS_ERR(fwnode)) {
300 status = PTR_ERR(fwnode);
304 pdev = platform_device_alloc("surface_gpe", PLATFORM_DEVID_NONE);
310 pdev->dev.fwnode = fwnode;
312 status = platform_device_add(pdev);
316 surface_gpe_device = pdev;
320 platform_device_put(pdev);
322 fwnode_remove_software_node(fwnode);
324 platform_driver_unregister(&surface_gpe_driver);
327 module_init(surface_gpe_init);
329 static void __exit surface_gpe_exit(void)
331 struct fwnode_handle *fwnode = surface_gpe_device->dev.fwnode;
333 platform_device_unregister(surface_gpe_device);
334 platform_driver_unregister(&surface_gpe_driver);
335 fwnode_remove_software_node(fwnode);
337 module_exit(surface_gpe_exit);
339 MODULE_AUTHOR("Maximilian Luz <luzmaximilian@gmail.com>");
340 MODULE_DESCRIPTION("Surface GPE/Lid Driver");
341 MODULE_LICENSE("GPL");
342 MODULE_ALIAS("dmi:*:svnMicrosoftCorporation:pnSurface*:*");