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