xref: /openbmc/linux/drivers/platform/x86/msi-wmi.c (revision 2c15644e)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * MSI WMI hotkeys
4  *
5  * Copyright (C) 2009 Novell <trenn@suse.de>
6  *
7  * Most stuff taken over from hp-wmi
8  */
9 
10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11 
12 #include <linux/kernel.h>
13 #include <linux/input.h>
14 #include <linux/input/sparse-keymap.h>
15 #include <linux/acpi.h>
16 #include <linux/backlight.h>
17 #include <linux/slab.h>
18 #include <linux/module.h>
19 #include <acpi/video.h>
20 
21 MODULE_AUTHOR("Thomas Renninger <trenn@suse.de>");
22 MODULE_DESCRIPTION("MSI laptop WMI hotkeys driver");
23 MODULE_LICENSE("GPL");
24 
25 #define DRV_NAME "msi-wmi"
26 
27 #define MSIWMI_BIOS_GUID "551A1F84-FBDD-4125-91DB-3EA8F44F1D45"
28 #define MSIWMI_MSI_EVENT_GUID "B6F3EEF2-3D2F-49DC-9DE3-85BCE18C62F2"
29 #define MSIWMI_WIND_EVENT_GUID "5B3CC38A-40D9-7245-8AE6-1145B751BE3F"
30 
31 MODULE_ALIAS("wmi:" MSIWMI_BIOS_GUID);
32 MODULE_ALIAS("wmi:" MSIWMI_MSI_EVENT_GUID);
33 MODULE_ALIAS("wmi:" MSIWMI_WIND_EVENT_GUID);
34 
35 enum msi_scancodes {
36 	/* Generic MSI keys (not present on MSI Wind) */
37 	MSI_KEY_BRIGHTNESSUP	= 0xD0,
38 	MSI_KEY_BRIGHTNESSDOWN,
39 	MSI_KEY_VOLUMEUP,
40 	MSI_KEY_VOLUMEDOWN,
41 	MSI_KEY_MUTE,
42 	/* MSI Wind keys */
43 	WIND_KEY_TOUCHPAD	= 0x08,	/* Fn+F3 touchpad toggle */
44 	WIND_KEY_BLUETOOTH	= 0x56,	/* Fn+F11 Bluetooth toggle */
45 	WIND_KEY_CAMERA,		/* Fn+F6 webcam toggle */
46 	WIND_KEY_WLAN		= 0x5f,	/* Fn+F11 Wi-Fi toggle */
47 	WIND_KEY_TURBO,			/* Fn+F10 turbo mode toggle */
48 	WIND_KEY_ECO		= 0x69,	/* Fn+F10 ECO mode toggle */
49 };
50 static struct key_entry msi_wmi_keymap[] = {
51 	{ KE_KEY, MSI_KEY_BRIGHTNESSUP,		{KEY_BRIGHTNESSUP} },
52 	{ KE_KEY, MSI_KEY_BRIGHTNESSDOWN,	{KEY_BRIGHTNESSDOWN} },
53 	{ KE_KEY, MSI_KEY_VOLUMEUP,		{KEY_VOLUMEUP} },
54 	{ KE_KEY, MSI_KEY_VOLUMEDOWN,		{KEY_VOLUMEDOWN} },
55 	{ KE_KEY, MSI_KEY_MUTE,			{KEY_MUTE} },
56 
57 	/* These keys work without WMI. Ignore them to avoid double keycodes */
58 	{ KE_IGNORE, WIND_KEY_TOUCHPAD,		{KEY_TOUCHPAD_TOGGLE} },
59 	{ KE_IGNORE, WIND_KEY_BLUETOOTH,	{KEY_BLUETOOTH} },
60 	{ KE_IGNORE, WIND_KEY_CAMERA,		{KEY_CAMERA} },
61 	{ KE_IGNORE, WIND_KEY_WLAN,		{KEY_WLAN} },
62 
63 	/* These are unknown WMI events found on MSI Wind */
64 	{ KE_IGNORE, 0x00 },
65 	{ KE_IGNORE, 0x62 },
66 	{ KE_IGNORE, 0x63 },
67 
68 	/* These are MSI Wind keys that should be handled via WMI */
69 	{ KE_KEY, WIND_KEY_TURBO,		{KEY_PROG1} },
70 	{ KE_KEY, WIND_KEY_ECO,			{KEY_PROG2} },
71 
72 	{ KE_END, 0 }
73 };
74 
75 static ktime_t last_pressed;
76 
77 static const struct {
78 	const char *guid;
79 	bool quirk_last_pressed;
80 } *event_wmi, event_wmis[] = {
81 	{ MSIWMI_MSI_EVENT_GUID, true },
82 	{ MSIWMI_WIND_EVENT_GUID, false },
83 };
84 
85 static struct backlight_device *backlight;
86 
87 static int backlight_map[] = { 0x00, 0x33, 0x66, 0x99, 0xCC, 0xFF };
88 
89 static struct input_dev *msi_wmi_input_dev;
90 
msi_wmi_query_block(int instance,int * ret)91 static int msi_wmi_query_block(int instance, int *ret)
92 {
93 	acpi_status status;
94 	union acpi_object *obj;
95 
96 	struct acpi_buffer output = { ACPI_ALLOCATE_BUFFER, NULL };
97 
98 	status = wmi_query_block(MSIWMI_BIOS_GUID, instance, &output);
99 	if (ACPI_FAILURE(status))
100 		return -EIO;
101 
102 	obj = output.pointer;
103 
104 	if (!obj || obj->type != ACPI_TYPE_INTEGER) {
105 		if (obj) {
106 			pr_err("query block returned object "
107 			       "type: %d - buffer length:%d\n", obj->type,
108 			       obj->type == ACPI_TYPE_BUFFER ?
109 			       obj->buffer.length : 0);
110 		}
111 		kfree(obj);
112 		return -EINVAL;
113 	}
114 	*ret = obj->integer.value;
115 	kfree(obj);
116 	return 0;
117 }
118 
msi_wmi_set_block(int instance,int value)119 static int msi_wmi_set_block(int instance, int value)
120 {
121 	acpi_status status;
122 
123 	struct acpi_buffer input = { sizeof(int), &value };
124 
125 	pr_debug("Going to set block of instance: %d - value: %d\n",
126 		 instance, value);
127 
128 	status = wmi_set_block(MSIWMI_BIOS_GUID, instance, &input);
129 
130 	return ACPI_SUCCESS(status) ? 0 : 1;
131 }
132 
bl_get(struct backlight_device * bd)133 static int bl_get(struct backlight_device *bd)
134 {
135 	int level, err, ret;
136 
137 	/* Instance 1 is "get backlight", cmp with DSDT */
138 	err = msi_wmi_query_block(1, &ret);
139 	if (err) {
140 		pr_err("Could not query backlight: %d\n", err);
141 		return -EINVAL;
142 	}
143 	pr_debug("Get: Query block returned: %d\n", ret);
144 	for (level = 0; level < ARRAY_SIZE(backlight_map); level++) {
145 		if (backlight_map[level] == ret) {
146 			pr_debug("Current backlight level: 0x%X - index: %d\n",
147 				 backlight_map[level], level);
148 			break;
149 		}
150 	}
151 	if (level == ARRAY_SIZE(backlight_map)) {
152 		pr_err("get: Invalid brightness value: 0x%X\n", ret);
153 		return -EINVAL;
154 	}
155 	return level;
156 }
157 
bl_set_status(struct backlight_device * bd)158 static int bl_set_status(struct backlight_device *bd)
159 {
160 	int bright = bd->props.brightness;
161 	if (bright >= ARRAY_SIZE(backlight_map) || bright < 0)
162 		return -EINVAL;
163 
164 	/* Instance 0 is "set backlight" */
165 	return msi_wmi_set_block(0, backlight_map[bright]);
166 }
167 
168 static const struct backlight_ops msi_backlight_ops = {
169 	.get_brightness	= bl_get,
170 	.update_status	= bl_set_status,
171 };
172 
msi_wmi_notify(u32 value,void * context)173 static void msi_wmi_notify(u32 value, void *context)
174 {
175 	struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
176 	struct key_entry *key;
177 	union acpi_object *obj;
178 	acpi_status status;
179 
180 	status = wmi_get_event_data(value, &response);
181 	if (status != AE_OK) {
182 		pr_info("bad event status 0x%x\n", status);
183 		return;
184 	}
185 
186 	obj = (union acpi_object *)response.pointer;
187 
188 	if (obj && obj->type == ACPI_TYPE_INTEGER) {
189 		int eventcode = obj->integer.value;
190 		pr_debug("Eventcode: 0x%x\n", eventcode);
191 		key = sparse_keymap_entry_from_scancode(msi_wmi_input_dev,
192 				eventcode);
193 		if (!key) {
194 			pr_info("Unknown key pressed - %x\n", eventcode);
195 			goto msi_wmi_notify_exit;
196 		}
197 
198 		if (event_wmi->quirk_last_pressed) {
199 			ktime_t cur = ktime_get_real();
200 			ktime_t diff = ktime_sub(cur, last_pressed);
201 			/* Ignore event if any event happened in a 50 ms
202 			   timeframe -> Key press may result in 10-20 GPEs */
203 			if (ktime_to_us(diff) < 1000 * 50) {
204 				pr_debug("Suppressed key event 0x%X - "
205 					 "Last press was %lld us ago\n",
206 					 key->code, ktime_to_us(diff));
207 				goto msi_wmi_notify_exit;
208 			}
209 			last_pressed = cur;
210 		}
211 
212 		if (key->type == KE_KEY &&
213 		/* Brightness is served via acpi video driver */
214 		(backlight ||
215 		(key->code != MSI_KEY_BRIGHTNESSUP &&
216 		key->code != MSI_KEY_BRIGHTNESSDOWN))) {
217 			pr_debug("Send key: 0x%X - Input layer keycode: %d\n",
218 				 key->code, key->keycode);
219 			sparse_keymap_report_entry(msi_wmi_input_dev, key, 1,
220 						   true);
221 		}
222 	} else
223 		pr_info("Unknown event received\n");
224 
225 msi_wmi_notify_exit:
226 	kfree(response.pointer);
227 }
228 
msi_wmi_backlight_setup(void)229 static int __init msi_wmi_backlight_setup(void)
230 {
231 	int err;
232 	struct backlight_properties props;
233 
234 	memset(&props, 0, sizeof(struct backlight_properties));
235 	props.type = BACKLIGHT_PLATFORM;
236 	props.max_brightness = ARRAY_SIZE(backlight_map) - 1;
237 	backlight = backlight_device_register(DRV_NAME, NULL, NULL,
238 					      &msi_backlight_ops,
239 					      &props);
240 	if (IS_ERR(backlight))
241 		return PTR_ERR(backlight);
242 
243 	err = bl_get(NULL);
244 	if (err < 0) {
245 		backlight_device_unregister(backlight);
246 		return err;
247 	}
248 
249 	backlight->props.brightness = err;
250 
251 	return 0;
252 }
253 
msi_wmi_input_setup(void)254 static int __init msi_wmi_input_setup(void)
255 {
256 	int err;
257 
258 	msi_wmi_input_dev = input_allocate_device();
259 	if (!msi_wmi_input_dev)
260 		return -ENOMEM;
261 
262 	msi_wmi_input_dev->name = "MSI WMI hotkeys";
263 	msi_wmi_input_dev->phys = "wmi/input0";
264 	msi_wmi_input_dev->id.bustype = BUS_HOST;
265 
266 	err = sparse_keymap_setup(msi_wmi_input_dev, msi_wmi_keymap, NULL);
267 	if (err)
268 		goto err_free_dev;
269 
270 	err = input_register_device(msi_wmi_input_dev);
271 
272 	if (err)
273 		goto err_free_dev;
274 
275 	last_pressed = 0;
276 
277 	return 0;
278 
279 err_free_dev:
280 	input_free_device(msi_wmi_input_dev);
281 	return err;
282 }
283 
msi_wmi_init(void)284 static int __init msi_wmi_init(void)
285 {
286 	int err;
287 	int i;
288 
289 	for (i = 0; i < ARRAY_SIZE(event_wmis); i++) {
290 		if (!wmi_has_guid(event_wmis[i].guid))
291 			continue;
292 
293 		err = msi_wmi_input_setup();
294 		if (err) {
295 			pr_err("Unable to setup input device\n");
296 			return err;
297 		}
298 
299 		err = wmi_install_notify_handler(event_wmis[i].guid,
300 			msi_wmi_notify, NULL);
301 		if (ACPI_FAILURE(err)) {
302 			pr_err("Unable to setup WMI notify handler\n");
303 			goto err_free_input;
304 		}
305 
306 		pr_debug("Event handler installed\n");
307 		event_wmi = &event_wmis[i];
308 		break;
309 	}
310 
311 	if (wmi_has_guid(MSIWMI_BIOS_GUID) &&
312 	    acpi_video_get_backlight_type() == acpi_backlight_vendor) {
313 		err = msi_wmi_backlight_setup();
314 		if (err) {
315 			pr_err("Unable to setup backlight device\n");
316 			goto err_uninstall_handler;
317 		}
318 		pr_debug("Backlight device created\n");
319 	}
320 
321 	if (!event_wmi && !backlight) {
322 		pr_err("This machine doesn't have neither MSI-hotkeys nor backlight through WMI\n");
323 		return -ENODEV;
324 	}
325 
326 	return 0;
327 
328 err_uninstall_handler:
329 	if (event_wmi)
330 		wmi_remove_notify_handler(event_wmi->guid);
331 err_free_input:
332 	if (event_wmi)
333 		input_unregister_device(msi_wmi_input_dev);
334 	return err;
335 }
336 
msi_wmi_exit(void)337 static void __exit msi_wmi_exit(void)
338 {
339 	if (event_wmi) {
340 		wmi_remove_notify_handler(event_wmi->guid);
341 		input_unregister_device(msi_wmi_input_dev);
342 	}
343 	backlight_device_unregister(backlight);
344 }
345 
346 module_init(msi_wmi_init);
347 module_exit(msi_wmi_exit);
348