msi-wmi.c 8.5 KB

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