Loading...
1/*
2 * MSI WMI hotkeys
3 *
4 * Copyright (C) 2009 Novell <trenn@suse.de>
5 *
6 * Most stuff taken over from hp-wmi
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
22
23#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
24
25#include <linux/kernel.h>
26#include <linux/input.h>
27#include <linux/input/sparse-keymap.h>
28#include <linux/acpi.h>
29#include <linux/backlight.h>
30#include <linux/slab.h>
31
32MODULE_AUTHOR("Thomas Renninger <trenn@suse.de>");
33MODULE_DESCRIPTION("MSI laptop WMI hotkeys driver");
34MODULE_LICENSE("GPL");
35
36MODULE_ALIAS("wmi:551A1F84-FBDD-4125-91DB-3EA8F44F1D45");
37MODULE_ALIAS("wmi:B6F3EEF2-3D2F-49DC-9DE3-85BCE18C62F2");
38
39#define DRV_NAME "msi-wmi"
40
41#define MSIWMI_BIOS_GUID "551A1F84-FBDD-4125-91DB-3EA8F44F1D45"
42#define MSIWMI_EVENT_GUID "B6F3EEF2-3D2F-49DC-9DE3-85BCE18C62F2"
43
44#define SCANCODE_BASE 0xD0
45#define MSI_WMI_BRIGHTNESSUP SCANCODE_BASE
46#define MSI_WMI_BRIGHTNESSDOWN (SCANCODE_BASE + 1)
47#define MSI_WMI_VOLUMEUP (SCANCODE_BASE + 2)
48#define MSI_WMI_VOLUMEDOWN (SCANCODE_BASE + 3)
49#define MSI_WMI_MUTE (SCANCODE_BASE + 4)
50static struct key_entry msi_wmi_keymap[] = {
51 { KE_KEY, MSI_WMI_BRIGHTNESSUP, {KEY_BRIGHTNESSUP} },
52 { KE_KEY, MSI_WMI_BRIGHTNESSDOWN, {KEY_BRIGHTNESSDOWN} },
53 { KE_KEY, MSI_WMI_VOLUMEUP, {KEY_VOLUMEUP} },
54 { KE_KEY, MSI_WMI_VOLUMEDOWN, {KEY_VOLUMEDOWN} },
55 { KE_KEY, MSI_WMI_MUTE, {KEY_MUTE} },
56 { KE_END, 0}
57};
58static ktime_t last_pressed[ARRAY_SIZE(msi_wmi_keymap) - 1];
59
60static struct backlight_device *backlight;
61
62static int backlight_map[] = { 0x00, 0x33, 0x66, 0x99, 0xCC, 0xFF };
63
64static struct input_dev *msi_wmi_input_dev;
65
66static int msi_wmi_query_block(int instance, int *ret)
67{
68 acpi_status status;
69 union acpi_object *obj;
70
71 struct acpi_buffer output = { ACPI_ALLOCATE_BUFFER, NULL };
72
73 status = wmi_query_block(MSIWMI_BIOS_GUID, instance, &output);
74
75 obj = output.pointer;
76
77 if (!obj || obj->type != ACPI_TYPE_INTEGER) {
78 if (obj) {
79 pr_err("query block returned object "
80 "type: %d - buffer length:%d\n", obj->type,
81 obj->type == ACPI_TYPE_BUFFER ?
82 obj->buffer.length : 0);
83 }
84 kfree(obj);
85 return -EINVAL;
86 }
87 *ret = obj->integer.value;
88 kfree(obj);
89 return 0;
90}
91
92static int msi_wmi_set_block(int instance, int value)
93{
94 acpi_status status;
95
96 struct acpi_buffer input = { sizeof(int), &value };
97
98 pr_debug("Going to set block of instance: %d - value: %d\n",
99 instance, value);
100
101 status = wmi_set_block(MSIWMI_BIOS_GUID, instance, &input);
102
103 return ACPI_SUCCESS(status) ? 0 : 1;
104}
105
106static int bl_get(struct backlight_device *bd)
107{
108 int level, err, ret;
109
110 /* Instance 1 is "get backlight", cmp with DSDT */
111 err = msi_wmi_query_block(1, &ret);
112 if (err) {
113 pr_err("Could not query backlight: %d\n", err);
114 return -EINVAL;
115 }
116 pr_debug("Get: Query block returned: %d\n", ret);
117 for (level = 0; level < ARRAY_SIZE(backlight_map); level++) {
118 if (backlight_map[level] == ret) {
119 pr_debug("Current backlight level: 0x%X - index: %d\n",
120 backlight_map[level], level);
121 break;
122 }
123 }
124 if (level == ARRAY_SIZE(backlight_map)) {
125 pr_err("get: Invalid brightness value: 0x%X\n", ret);
126 return -EINVAL;
127 }
128 return level;
129}
130
131static int bl_set_status(struct backlight_device *bd)
132{
133 int bright = bd->props.brightness;
134 if (bright >= ARRAY_SIZE(backlight_map) || bright < 0)
135 return -EINVAL;
136
137 /* Instance 0 is "set backlight" */
138 return msi_wmi_set_block(0, backlight_map[bright]);
139}
140
141static const struct backlight_ops msi_backlight_ops = {
142 .get_brightness = bl_get,
143 .update_status = bl_set_status,
144};
145
146static void msi_wmi_notify(u32 value, void *context)
147{
148 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
149 static struct key_entry *key;
150 union acpi_object *obj;
151 ktime_t cur;
152 acpi_status status;
153
154 status = wmi_get_event_data(value, &response);
155 if (status != AE_OK) {
156 pr_info("bad event status 0x%x\n", status);
157 return;
158 }
159
160 obj = (union acpi_object *)response.pointer;
161
162 if (obj && obj->type == ACPI_TYPE_INTEGER) {
163 int eventcode = obj->integer.value;
164 pr_debug("Eventcode: 0x%x\n", eventcode);
165 key = sparse_keymap_entry_from_scancode(msi_wmi_input_dev,
166 eventcode);
167 if (key) {
168 ktime_t diff;
169 cur = ktime_get_real();
170 diff = ktime_sub(cur, last_pressed[key->code -
171 SCANCODE_BASE]);
172 /* Ignore event if the same event happened in a 50 ms
173 timeframe -> Key press may result in 10-20 GPEs */
174 if (ktime_to_us(diff) < 1000 * 50) {
175 pr_debug("Suppressed key event 0x%X - "
176 "Last press was %lld us ago\n",
177 key->code, ktime_to_us(diff));
178 return;
179 }
180 last_pressed[key->code - SCANCODE_BASE] = cur;
181
182 if (key->type == KE_KEY &&
183 /* Brightness is served via acpi video driver */
184 (!acpi_video_backlight_support() ||
185 (key->code != MSI_WMI_BRIGHTNESSUP &&
186 key->code != MSI_WMI_BRIGHTNESSDOWN))) {
187 pr_debug("Send key: 0x%X - "
188 "Input layer keycode: %d\n",
189 key->code, key->keycode);
190 sparse_keymap_report_entry(msi_wmi_input_dev,
191 key, 1, true);
192 }
193 } else
194 pr_info("Unknown key pressed - %x\n", eventcode);
195 } else
196 pr_info("Unknown event received\n");
197 kfree(response.pointer);
198}
199
200static int __init msi_wmi_input_setup(void)
201{
202 int err;
203
204 msi_wmi_input_dev = input_allocate_device();
205 if (!msi_wmi_input_dev)
206 return -ENOMEM;
207
208 msi_wmi_input_dev->name = "MSI WMI hotkeys";
209 msi_wmi_input_dev->phys = "wmi/input0";
210 msi_wmi_input_dev->id.bustype = BUS_HOST;
211
212 err = sparse_keymap_setup(msi_wmi_input_dev, msi_wmi_keymap, NULL);
213 if (err)
214 goto err_free_dev;
215
216 err = input_register_device(msi_wmi_input_dev);
217
218 if (err)
219 goto err_free_keymap;
220
221 memset(last_pressed, 0, sizeof(last_pressed));
222
223 return 0;
224
225err_free_keymap:
226 sparse_keymap_free(msi_wmi_input_dev);
227err_free_dev:
228 input_free_device(msi_wmi_input_dev);
229 return err;
230}
231
232static int __init msi_wmi_init(void)
233{
234 int err;
235
236 if (!wmi_has_guid(MSIWMI_EVENT_GUID)) {
237 pr_err("This machine doesn't have MSI-hotkeys through WMI\n");
238 return -ENODEV;
239 }
240 err = wmi_install_notify_handler(MSIWMI_EVENT_GUID,
241 msi_wmi_notify, NULL);
242 if (ACPI_FAILURE(err))
243 return -EINVAL;
244
245 err = msi_wmi_input_setup();
246 if (err)
247 goto err_uninstall_notifier;
248
249 if (!acpi_video_backlight_support()) {
250 struct backlight_properties props;
251 memset(&props, 0, sizeof(struct backlight_properties));
252 props.type = BACKLIGHT_PLATFORM;
253 props.max_brightness = ARRAY_SIZE(backlight_map) - 1;
254 backlight = backlight_device_register(DRV_NAME, NULL, NULL,
255 &msi_backlight_ops,
256 &props);
257 if (IS_ERR(backlight)) {
258 err = PTR_ERR(backlight);
259 goto err_free_input;
260 }
261
262 err = bl_get(NULL);
263 if (err < 0)
264 goto err_free_backlight;
265
266 backlight->props.brightness = err;
267 }
268 pr_debug("Event handler installed\n");
269
270 return 0;
271
272err_free_backlight:
273 backlight_device_unregister(backlight);
274err_free_input:
275 sparse_keymap_free(msi_wmi_input_dev);
276 input_unregister_device(msi_wmi_input_dev);
277err_uninstall_notifier:
278 wmi_remove_notify_handler(MSIWMI_EVENT_GUID);
279 return err;
280}
281
282static void __exit msi_wmi_exit(void)
283{
284 if (wmi_has_guid(MSIWMI_EVENT_GUID)) {
285 wmi_remove_notify_handler(MSIWMI_EVENT_GUID);
286 sparse_keymap_free(msi_wmi_input_dev);
287 input_unregister_device(msi_wmi_input_dev);
288 backlight_device_unregister(backlight);
289 }
290}
291
292module_init(msi_wmi_init);
293module_exit(msi_wmi_exit);
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
21MODULE_AUTHOR("Thomas Renninger <trenn@suse.de>");
22MODULE_DESCRIPTION("MSI laptop WMI hotkeys driver");
23MODULE_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
31MODULE_ALIAS("wmi:" MSIWMI_BIOS_GUID);
32MODULE_ALIAS("wmi:" MSIWMI_MSI_EVENT_GUID);
33MODULE_ALIAS("wmi:" MSIWMI_WIND_EVENT_GUID);
34
35enum 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};
50static 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
75static ktime_t last_pressed;
76
77static 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
85static struct backlight_device *backlight;
86
87static int backlight_map[] = { 0x00, 0x33, 0x66, 0x99, 0xCC, 0xFF };
88
89static struct input_dev *msi_wmi_input_dev;
90
91static 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) {
104 pr_err("query block returned object "
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
117static int msi_wmi_set_block(int instance, int value)
118{
119 acpi_status status;
120
121 struct acpi_buffer input = { sizeof(int), &value };
122
123 pr_debug("Going to set block of instance: %d - value: %d\n",
124 instance, value);
125
126 status = wmi_set_block(MSIWMI_BIOS_GUID, instance, &input);
127
128 return ACPI_SUCCESS(status) ? 0 : 1;
129}
130
131static int bl_get(struct backlight_device *bd)
132{
133 int level, err, ret;
134
135 /* Instance 1 is "get backlight", cmp with DSDT */
136 err = msi_wmi_query_block(1, &ret);
137 if (err) {
138 pr_err("Could not query backlight: %d\n", err);
139 return -EINVAL;
140 }
141 pr_debug("Get: Query block returned: %d\n", ret);
142 for (level = 0; level < ARRAY_SIZE(backlight_map); level++) {
143 if (backlight_map[level] == ret) {
144 pr_debug("Current backlight level: 0x%X - index: %d\n",
145 backlight_map[level], level);
146 break;
147 }
148 }
149 if (level == ARRAY_SIZE(backlight_map)) {
150 pr_err("get: Invalid brightness value: 0x%X\n", ret);
151 return -EINVAL;
152 }
153 return level;
154}
155
156static 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
166static const struct backlight_ops msi_backlight_ops = {
167 .get_brightness = bl_get,
168 .update_status = bl_set_status,
169};
170
171static void msi_wmi_notify(u32 value, void *context)
172{
173 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
174 struct key_entry *key;
175 union acpi_object *obj;
176 acpi_status status;
177
178 status = wmi_get_event_data(value, &response);
179 if (status != AE_OK) {
180 pr_info("bad event status 0x%x\n", status);
181 return;
182 }
183
184 obj = (union acpi_object *)response.pointer;
185
186 if (obj && obj->type == ACPI_TYPE_INTEGER) {
187 int eventcode = obj->integer.value;
188 pr_debug("Eventcode: 0x%x\n", eventcode);
189 key = sparse_keymap_entry_from_scancode(msi_wmi_input_dev,
190 eventcode);
191 if (!key) {
192 pr_info("Unknown key pressed - %x\n", eventcode);
193 goto msi_wmi_notify_exit;
194 }
195
196 if (event_wmi->quirk_last_pressed) {
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
200 timeframe -> Key press may result in 10-20 GPEs */
201 if (ktime_to_us(diff) < 1000 * 50) {
202 pr_debug("Suppressed key event 0x%X - "
203 "Last press was %lld us ago\n",
204 key->code, ktime_to_us(diff));
205 goto msi_wmi_notify_exit;
206 }
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 }
220 } else
221 pr_info("Unknown event received\n");
222
223msi_wmi_notify_exit:
224 kfree(response.pointer);
225}
226
227static 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
252static int __init msi_wmi_input_setup(void)
253{
254 int err;
255
256 msi_wmi_input_dev = input_allocate_device();
257 if (!msi_wmi_input_dev)
258 return -ENOMEM;
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;
263
264 err = sparse_keymap_setup(msi_wmi_input_dev, msi_wmi_keymap, NULL);
265 if (err)
266 goto err_free_dev;
267
268 err = input_register_device(msi_wmi_input_dev);
269
270 if (err)
271 goto err_free_dev;
272
273 last_pressed = 0;
274
275 return 0;
276
277err_free_dev:
278 input_free_device(msi_wmi_input_dev);
279 return err;
280}
281
282static int __init msi_wmi_init(void)
283{
284 int err;
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;
290
291 err = msi_wmi_input_setup();
292 if (err) {
293 pr_err("Unable to setup input device\n");
294 return err;
295 }
296
297 err = wmi_install_notify_handler(event_wmis[i].guid,
298 msi_wmi_notify, NULL);
299 if (ACPI_FAILURE(err)) {
300 pr_err("Unable to setup WMI notify handler\n");
301 goto err_free_input;
302 }
303
304 pr_debug("Event handler installed\n");
305 event_wmi = &event_wmis[i];
306 break;
307 }
308
309 if (wmi_has_guid(MSIWMI_BIOS_GUID) &&
310 acpi_video_get_backlight_type() == acpi_backlight_vendor) {
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 }
318
319 if (!event_wmi && !backlight) {
320 pr_err("This machine doesn't have neither MSI-hotkeys nor backlight through WMI\n");
321 return -ENODEV;
322 }
323
324 return 0;
325
326err_uninstall_handler:
327 if (event_wmi)
328 wmi_remove_notify_handler(event_wmi->guid);
329err_free_input:
330 if (event_wmi)
331 input_unregister_device(msi_wmi_input_dev);
332 return err;
333}
334
335static void __exit msi_wmi_exit(void)
336{
337 if (event_wmi) {
338 wmi_remove_notify_handler(event_wmi->guid);
339 input_unregister_device(msi_wmi_input_dev);
340 }
341 backlight_device_unregister(backlight);
342}
343
344module_init(msi_wmi_init);
345module_exit(msi_wmi_exit);