dell-wmi.c 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * Dell WMI hotkeys
  4. *
  5. * Copyright (C) 2008 Red Hat <mjg@redhat.com>
  6. * Copyright (C) 2014-2015 Pali Rohár <pali@kernel.org>
  7. *
  8. * Portions based on wistron_btns.c:
  9. * Copyright (C) 2005 Miloslav Trmac <mitr@volny.cz>
  10. * Copyright (C) 2005 Bernhard Rosenkraenzer <bero@arklinux.org>
  11. * Copyright (C) 2005 Dmitry Torokhov <dtor@mail.ru>
  12. */
  13. #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  14. #include <linux/kernel.h>
  15. #include <linux/module.h>
  16. #include <linux/init.h>
  17. #include <linux/slab.h>
  18. #include <linux/types.h>
  19. #include <linux/input.h>
  20. #include <linux/input/sparse-keymap.h>
  21. #include <linux/acpi.h>
  22. #include <linux/string.h>
  23. #include <linux/dmi.h>
  24. #include <linux/wmi.h>
  25. #include <acpi/video.h>
  26. #include "dell-smbios.h"
  27. #include "dell-wmi-descriptor.h"
  28. MODULE_AUTHOR("Matthew Garrett <mjg@redhat.com>");
  29. MODULE_AUTHOR("Pali Rohár <pali@kernel.org>");
  30. MODULE_DESCRIPTION("Dell laptop WMI hotkeys driver");
  31. MODULE_LICENSE("GPL");
  32. #define DELL_EVENT_GUID "9DBB5994-A997-11DA-B012-B622A1EF5492"
  33. static bool wmi_requires_smbios_request;
  34. struct dell_wmi_priv {
  35. struct input_dev *input_dev;
  36. u32 interface_version;
  37. };
  38. static int __init dmi_matched(const struct dmi_system_id *dmi)
  39. {
  40. wmi_requires_smbios_request = 1;
  41. return 1;
  42. }
  43. static const struct dmi_system_id dell_wmi_smbios_list[] __initconst = {
  44. {
  45. .callback = dmi_matched,
  46. .ident = "Dell Inspiron M5110",
  47. .matches = {
  48. DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
  49. DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron M5110"),
  50. },
  51. },
  52. {
  53. .callback = dmi_matched,
  54. .ident = "Dell Vostro V131",
  55. .matches = {
  56. DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
  57. DMI_MATCH(DMI_PRODUCT_NAME, "Vostro V131"),
  58. },
  59. },
  60. { }
  61. };
  62. /*
  63. * Keymap for WMI events of type 0x0000
  64. *
  65. * Certain keys are flagged as KE_IGNORE. All of these are either
  66. * notifications (rather than requests for change) or are also sent
  67. * via the keyboard controller so should not be sent again.
  68. */
  69. static const struct key_entry dell_wmi_keymap_type_0000[] = {
  70. { KE_IGNORE, 0x003a, { KEY_CAPSLOCK } },
  71. /* Key code is followed by brightness level */
  72. { KE_KEY, 0xe005, { KEY_BRIGHTNESSDOWN } },
  73. { KE_KEY, 0xe006, { KEY_BRIGHTNESSUP } },
  74. /* Battery health status button */
  75. { KE_KEY, 0xe007, { KEY_BATTERY } },
  76. /* Radio devices state change, key code is followed by other values */
  77. { KE_IGNORE, 0xe008, { KEY_RFKILL } },
  78. { KE_KEY, 0xe009, { KEY_EJECTCD } },
  79. /* Key code is followed by: next, active and attached devices */
  80. { KE_KEY, 0xe00b, { KEY_SWITCHVIDEOMODE } },
  81. /* Key code is followed by keyboard illumination level */
  82. { KE_IGNORE, 0xe00c, { KEY_KBDILLUMTOGGLE } },
  83. /* BIOS error detected */
  84. { KE_IGNORE, 0xe00d, { KEY_RESERVED } },
  85. /* Battery was removed or inserted */
  86. { KE_IGNORE, 0xe00e, { KEY_RESERVED } },
  87. /* Wifi Catcher */
  88. { KE_KEY, 0xe011, { KEY_WLAN } },
  89. /* Ambient light sensor toggle */
  90. { KE_IGNORE, 0xe013, { KEY_RESERVED } },
  91. { KE_IGNORE, 0xe020, { KEY_MUTE } },
  92. /* Unknown, defined in ACPI DSDT */
  93. /* { KE_IGNORE, 0xe023, { KEY_RESERVED } }, */
  94. /* Untested, Dell Instant Launch key on Inspiron 7520 */
  95. /* { KE_IGNORE, 0xe024, { KEY_RESERVED } }, */
  96. /* Dell Instant Launch key */
  97. { KE_KEY, 0xe025, { KEY_PROG4 } },
  98. /* Audio panel key */
  99. { KE_IGNORE, 0xe026, { KEY_RESERVED } },
  100. /* LCD Display On/Off Control key */
  101. { KE_KEY, 0xe027, { KEY_DISPLAYTOGGLE } },
  102. /* Untested, Multimedia key on Dell Vostro 3560 */
  103. /* { KE_IGNORE, 0xe028, { KEY_RESERVED } }, */
  104. /* Dell Instant Launch key */
  105. { KE_KEY, 0xe029, { KEY_PROG4 } },
  106. /* Untested, Windows Mobility Center button on Inspiron 7520 */
  107. /* { KE_IGNORE, 0xe02a, { KEY_RESERVED } }, */
  108. /* Unknown, defined in ACPI DSDT */
  109. /* { KE_IGNORE, 0xe02b, { KEY_RESERVED } }, */
  110. /* Untested, Dell Audio With Preset Switch button on Inspiron 7520 */
  111. /* { KE_IGNORE, 0xe02c, { KEY_RESERVED } }, */
  112. { KE_IGNORE, 0xe02e, { KEY_VOLUMEDOWN } },
  113. { KE_IGNORE, 0xe030, { KEY_VOLUMEUP } },
  114. { KE_IGNORE, 0xe033, { KEY_KBDILLUMUP } },
  115. { KE_IGNORE, 0xe034, { KEY_KBDILLUMDOWN } },
  116. { KE_IGNORE, 0xe03a, { KEY_CAPSLOCK } },
  117. /* NIC Link is Up */
  118. { KE_IGNORE, 0xe043, { KEY_RESERVED } },
  119. /* NIC Link is Down */
  120. { KE_IGNORE, 0xe044, { KEY_RESERVED } },
  121. /*
  122. * This entry is very suspicious!
  123. * Originally Matthew Garrett created this dell-wmi driver specially for
  124. * "button with a picture of a battery" which has event code 0xe045.
  125. * Later Mario Limonciello from Dell told us that event code 0xe045 is
  126. * reported by Num Lock and should be ignored because key is send also
  127. * by keyboard controller.
  128. * So for now we will ignore this event to prevent potential double
  129. * Num Lock key press.
  130. */
  131. { KE_IGNORE, 0xe045, { KEY_NUMLOCK } },
  132. /* Scroll lock and also going to tablet mode on portable devices */
  133. { KE_IGNORE, 0xe046, { KEY_SCROLLLOCK } },
  134. /* Untested, going from tablet mode on portable devices */
  135. /* { KE_IGNORE, 0xe047, { KEY_RESERVED } }, */
  136. /* Dell Support Center key */
  137. { KE_IGNORE, 0xe06e, { KEY_RESERVED } },
  138. { KE_IGNORE, 0xe0f7, { KEY_MUTE } },
  139. { KE_IGNORE, 0xe0f8, { KEY_VOLUMEDOWN } },
  140. { KE_IGNORE, 0xe0f9, { KEY_VOLUMEUP } },
  141. };
  142. struct dell_bios_keymap_entry {
  143. u16 scancode;
  144. u16 keycode;
  145. };
  146. struct dell_bios_hotkey_table {
  147. struct dmi_header header;
  148. struct dell_bios_keymap_entry keymap[];
  149. };
  150. struct dell_dmi_results {
  151. int err;
  152. int keymap_size;
  153. struct key_entry *keymap;
  154. };
  155. /* Uninitialized entries here are KEY_RESERVED == 0. */
  156. static const u16 bios_to_linux_keycode[256] = {
  157. [0] = KEY_MEDIA,
  158. [1] = KEY_NEXTSONG,
  159. [2] = KEY_PLAYPAUSE,
  160. [3] = KEY_PREVIOUSSONG,
  161. [4] = KEY_STOPCD,
  162. [5] = KEY_UNKNOWN,
  163. [6] = KEY_UNKNOWN,
  164. [7] = KEY_UNKNOWN,
  165. [8] = KEY_WWW,
  166. [9] = KEY_UNKNOWN,
  167. [10] = KEY_VOLUMEDOWN,
  168. [11] = KEY_MUTE,
  169. [12] = KEY_VOLUMEUP,
  170. [13] = KEY_UNKNOWN,
  171. [14] = KEY_BATTERY,
  172. [15] = KEY_EJECTCD,
  173. [16] = KEY_UNKNOWN,
  174. [17] = KEY_SLEEP,
  175. [18] = KEY_PROG1,
  176. [19] = KEY_BRIGHTNESSDOWN,
  177. [20] = KEY_BRIGHTNESSUP,
  178. [21] = KEY_BRIGHTNESS_AUTO,
  179. [22] = KEY_KBDILLUMTOGGLE,
  180. [23] = KEY_UNKNOWN,
  181. [24] = KEY_SWITCHVIDEOMODE,
  182. [25] = KEY_UNKNOWN,
  183. [26] = KEY_UNKNOWN,
  184. [27] = KEY_SWITCHVIDEOMODE,
  185. [28] = KEY_UNKNOWN,
  186. [29] = KEY_UNKNOWN,
  187. [30] = KEY_PROG2,
  188. [31] = KEY_UNKNOWN,
  189. [32] = KEY_UNKNOWN,
  190. [33] = KEY_UNKNOWN,
  191. [34] = KEY_UNKNOWN,
  192. [35] = KEY_UNKNOWN,
  193. [36] = KEY_UNKNOWN,
  194. [37] = KEY_UNKNOWN,
  195. [38] = KEY_MICMUTE,
  196. [255] = KEY_PROG3,
  197. };
  198. /*
  199. * Keymap for WMI events of type 0x0010
  200. *
  201. * These are applied if the 0xB2 DMI hotkey table is present and doesn't
  202. * override them.
  203. */
  204. static const struct key_entry dell_wmi_keymap_type_0010[] = {
  205. /* Fn-lock switched to function keys */
  206. { KE_IGNORE, 0x0, { KEY_RESERVED } },
  207. /* Fn-lock switched to multimedia keys */
  208. { KE_IGNORE, 0x1, { KEY_RESERVED } },
  209. /* Keyboard backlight change notification */
  210. { KE_IGNORE, 0x3f, { KEY_RESERVED } },
  211. /* Backlight brightness level */
  212. { KE_KEY, 0x57, { KEY_BRIGHTNESSDOWN } },
  213. { KE_KEY, 0x58, { KEY_BRIGHTNESSUP } },
  214. /* Mic mute */
  215. { KE_KEY, 0x150, { KEY_MICMUTE } },
  216. /* Fn-lock */
  217. { KE_IGNORE, 0x151, { KEY_RESERVED } },
  218. /* Change keyboard illumination */
  219. { KE_IGNORE, 0x152, { KEY_KBDILLUMTOGGLE } },
  220. /*
  221. * Radio disable (notify only -- there is no model for which the
  222. * WMI event is supposed to trigger an action).
  223. */
  224. { KE_IGNORE, 0x153, { KEY_RFKILL } },
  225. /* RGB keyboard backlight control */
  226. { KE_IGNORE, 0x154, { KEY_RESERVED } },
  227. /*
  228. * Stealth mode toggle. This will "disable all lights and sounds".
  229. * The action is performed by the BIOS and EC; the WMI event is just
  230. * a notification. On the XPS 13 9350, this is Fn+F7, and there's
  231. * a BIOS setting to enable and disable the hotkey.
  232. */
  233. { KE_IGNORE, 0x155, { KEY_RESERVED } },
  234. /* Rugged magnetic dock attach/detach events */
  235. { KE_IGNORE, 0x156, { KEY_RESERVED } },
  236. { KE_IGNORE, 0x157, { KEY_RESERVED } },
  237. /* Rugged programmable (P1/P2/P3 keys) */
  238. { KE_KEY, 0x850, { KEY_PROG1 } },
  239. { KE_KEY, 0x851, { KEY_PROG2 } },
  240. { KE_KEY, 0x852, { KEY_PROG3 } },
  241. /*
  242. * Radio disable (notify only -- there is no model for which the
  243. * WMI event is supposed to trigger an action).
  244. */
  245. { KE_IGNORE, 0xe008, { KEY_RFKILL } },
  246. /* Fn-lock */
  247. { KE_IGNORE, 0xe035, { KEY_RESERVED } },
  248. };
  249. /*
  250. * Keymap for WMI events of type 0x0011
  251. */
  252. static const struct key_entry dell_wmi_keymap_type_0011[] = {
  253. /* Battery unplugged */
  254. { KE_IGNORE, 0xfff0, { KEY_RESERVED } },
  255. /* Battery inserted */
  256. { KE_IGNORE, 0xfff1, { KEY_RESERVED } },
  257. /*
  258. * Detachable keyboard detached / undocked
  259. * Note SW_TABLET_MODE is already reported through the intel_vbtn
  260. * driver for this, so we ignore it.
  261. */
  262. { KE_IGNORE, 0xfff2, { KEY_RESERVED } },
  263. /* Detachable keyboard attached / docked */
  264. { KE_IGNORE, 0xfff3, { KEY_RESERVED } },
  265. /* Keyboard backlight level changed */
  266. { KE_IGNORE, KBD_LED_OFF_TOKEN, { KEY_RESERVED } },
  267. { KE_IGNORE, KBD_LED_ON_TOKEN, { KEY_RESERVED } },
  268. { KE_IGNORE, KBD_LED_AUTO_TOKEN, { KEY_RESERVED } },
  269. { KE_IGNORE, KBD_LED_AUTO_25_TOKEN, { KEY_RESERVED } },
  270. { KE_IGNORE, KBD_LED_AUTO_50_TOKEN, { KEY_RESERVED } },
  271. { KE_IGNORE, KBD_LED_AUTO_75_TOKEN, { KEY_RESERVED } },
  272. { KE_IGNORE, KBD_LED_AUTO_100_TOKEN, { KEY_RESERVED } },
  273. };
  274. /*
  275. * Keymap for WMI events of type 0x0012
  276. * They are events with extended data
  277. */
  278. static const struct key_entry dell_wmi_keymap_type_0012[] = {
  279. /* Fn-lock button pressed */
  280. { KE_IGNORE, 0xe035, { KEY_RESERVED } },
  281. };
  282. static void dell_wmi_process_key(struct wmi_device *wdev, int type, int code)
  283. {
  284. struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
  285. const struct key_entry *key;
  286. key = sparse_keymap_entry_from_scancode(priv->input_dev,
  287. (type << 16) | code);
  288. if (!key) {
  289. pr_info("Unknown key with type 0x%04x and code 0x%04x pressed\n",
  290. type, code);
  291. return;
  292. }
  293. pr_debug("Key with type 0x%04x and code 0x%04x pressed\n", type, code);
  294. /* Don't report brightness notifications that will also come via ACPI */
  295. if ((key->keycode == KEY_BRIGHTNESSUP ||
  296. key->keycode == KEY_BRIGHTNESSDOWN) &&
  297. acpi_video_handles_brightness_key_presses())
  298. return;
  299. if (type == 0x0000 && code == 0xe025 && !wmi_requires_smbios_request)
  300. return;
  301. if (key->keycode == KEY_KBDILLUMTOGGLE)
  302. dell_laptop_call_notifier(
  303. DELL_LAPTOP_KBD_BACKLIGHT_BRIGHTNESS_CHANGED, NULL);
  304. sparse_keymap_report_entry(priv->input_dev, key, 1, true);
  305. }
  306. static void dell_wmi_notify(struct wmi_device *wdev,
  307. union acpi_object *obj)
  308. {
  309. struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
  310. u16 *buffer_entry, *buffer_end;
  311. acpi_size buffer_size;
  312. int len, i;
  313. if (obj->type != ACPI_TYPE_BUFFER) {
  314. pr_warn("bad response type %x\n", obj->type);
  315. return;
  316. }
  317. pr_debug("Received WMI event (%*ph)\n",
  318. obj->buffer.length, obj->buffer.pointer);
  319. buffer_entry = (u16 *)obj->buffer.pointer;
  320. buffer_size = obj->buffer.length/2;
  321. buffer_end = buffer_entry + buffer_size;
  322. /*
  323. * BIOS/ACPI on devices with WMI interface version 0 does not clear
  324. * buffer before filling it. So next time when BIOS/ACPI send WMI event
  325. * which is smaller as previous then it contains garbage in buffer from
  326. * previous event.
  327. *
  328. * BIOS/ACPI on devices with WMI interface version 1 clears buffer and
  329. * sometimes send more events in buffer at one call.
  330. *
  331. * So to prevent reading garbage from buffer we will process only first
  332. * one event on devices with WMI interface version 0.
  333. */
  334. if (priv->interface_version == 0 && buffer_entry < buffer_end)
  335. if (buffer_end > buffer_entry + buffer_entry[0] + 1)
  336. buffer_end = buffer_entry + buffer_entry[0] + 1;
  337. while (buffer_entry < buffer_end) {
  338. len = buffer_entry[0];
  339. if (len == 0)
  340. break;
  341. len++;
  342. if (buffer_entry + len > buffer_end) {
  343. pr_warn("Invalid length of WMI event\n");
  344. break;
  345. }
  346. pr_debug("Process buffer (%*ph)\n", len*2, buffer_entry);
  347. switch (buffer_entry[1]) {
  348. case 0x0000: /* One key pressed or event occurred */
  349. case 0x0012: /* Event with extended data occurred */
  350. if (len > 2)
  351. dell_wmi_process_key(wdev, buffer_entry[1],
  352. buffer_entry[2]);
  353. /* Extended data is currently ignored */
  354. break;
  355. case 0x0010: /* Sequence of keys pressed */
  356. case 0x0011: /* Sequence of events occurred */
  357. for (i = 2; i < len; ++i)
  358. dell_wmi_process_key(wdev, buffer_entry[1],
  359. buffer_entry[i]);
  360. break;
  361. default: /* Unknown event */
  362. pr_info("Unknown WMI event type 0x%x\n",
  363. (int)buffer_entry[1]);
  364. break;
  365. }
  366. buffer_entry += len;
  367. }
  368. }
  369. static bool have_scancode(u32 scancode, const struct key_entry *keymap, int len)
  370. {
  371. int i;
  372. for (i = 0; i < len; i++)
  373. if (keymap[i].code == scancode)
  374. return true;
  375. return false;
  376. }
  377. static void handle_dmi_entry(const struct dmi_header *dm, void *opaque)
  378. {
  379. struct dell_dmi_results *results = opaque;
  380. struct dell_bios_hotkey_table *table;
  381. int hotkey_num, i, pos = 0;
  382. struct key_entry *keymap;
  383. if (results->err || results->keymap)
  384. return; /* We already found the hotkey table. */
  385. /* The Dell hotkey table is type 0xB2. Scan until we find it. */
  386. if (dm->type != 0xb2)
  387. return;
  388. table = container_of(dm, struct dell_bios_hotkey_table, header);
  389. hotkey_num = (table->header.length -
  390. sizeof(struct dell_bios_hotkey_table)) /
  391. sizeof(struct dell_bios_keymap_entry);
  392. if (hotkey_num < 1) {
  393. /*
  394. * Historically, dell-wmi would ignore a DMI entry of
  395. * fewer than 7 bytes. Sizes between 4 and 8 bytes are
  396. * nonsensical (both the header and all entries are 4
  397. * bytes), so we approximate the old behavior by
  398. * ignoring tables with fewer than one entry.
  399. */
  400. return;
  401. }
  402. keymap = kcalloc(hotkey_num, sizeof(struct key_entry), GFP_KERNEL);
  403. if (!keymap) {
  404. results->err = -ENOMEM;
  405. return;
  406. }
  407. for (i = 0; i < hotkey_num; i++) {
  408. const struct dell_bios_keymap_entry *bios_entry =
  409. &table->keymap[i];
  410. /* Uninitialized entries are 0 aka KEY_RESERVED. */
  411. u16 keycode = (bios_entry->keycode <
  412. ARRAY_SIZE(bios_to_linux_keycode)) ?
  413. bios_to_linux_keycode[bios_entry->keycode] :
  414. (bios_entry->keycode == 0xffff ? KEY_UNKNOWN : KEY_RESERVED);
  415. /*
  416. * Log if we find an entry in the DMI table that we don't
  417. * understand. If this happens, we should figure out what
  418. * the entry means and add it to bios_to_linux_keycode.
  419. */
  420. if (keycode == KEY_RESERVED) {
  421. pr_info("firmware scancode 0x%x maps to unrecognized keycode 0x%x\n",
  422. bios_entry->scancode, bios_entry->keycode);
  423. continue;
  424. }
  425. if (keycode == KEY_KBDILLUMTOGGLE)
  426. keymap[pos].type = KE_IGNORE;
  427. else
  428. keymap[pos].type = KE_KEY;
  429. keymap[pos].code = bios_entry->scancode;
  430. keymap[pos].keycode = keycode;
  431. pos++;
  432. }
  433. results->keymap = keymap;
  434. results->keymap_size = pos;
  435. }
  436. static int dell_wmi_input_setup(struct wmi_device *wdev)
  437. {
  438. struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
  439. struct dell_dmi_results dmi_results = {};
  440. struct key_entry *keymap;
  441. int err, i, pos = 0;
  442. priv->input_dev = input_allocate_device();
  443. if (!priv->input_dev)
  444. return -ENOMEM;
  445. priv->input_dev->name = "Dell WMI hotkeys";
  446. priv->input_dev->id.bustype = BUS_HOST;
  447. priv->input_dev->dev.parent = &wdev->dev;
  448. if (dmi_walk(handle_dmi_entry, &dmi_results)) {
  449. /*
  450. * Historically, dell-wmi ignored dmi_walk errors. A failure
  451. * is certainly surprising, but it probably just indicates
  452. * a very old laptop.
  453. */
  454. pr_warn("no DMI; using the old-style hotkey interface\n");
  455. }
  456. if (dmi_results.err) {
  457. err = dmi_results.err;
  458. goto err_free_dev;
  459. }
  460. keymap = kcalloc(dmi_results.keymap_size +
  461. ARRAY_SIZE(dell_wmi_keymap_type_0000) +
  462. ARRAY_SIZE(dell_wmi_keymap_type_0010) +
  463. ARRAY_SIZE(dell_wmi_keymap_type_0011) +
  464. ARRAY_SIZE(dell_wmi_keymap_type_0012) +
  465. 1,
  466. sizeof(struct key_entry), GFP_KERNEL);
  467. if (!keymap) {
  468. kfree(dmi_results.keymap);
  469. err = -ENOMEM;
  470. goto err_free_dev;
  471. }
  472. /* Append table with events of type 0x0010 which comes from DMI */
  473. for (i = 0; i < dmi_results.keymap_size; i++) {
  474. keymap[pos] = dmi_results.keymap[i];
  475. keymap[pos].code |= (0x0010 << 16);
  476. pos++;
  477. }
  478. kfree(dmi_results.keymap);
  479. /* Append table with extra events of type 0x0010 which are not in DMI */
  480. for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0010); i++) {
  481. const struct key_entry *entry = &dell_wmi_keymap_type_0010[i];
  482. /*
  483. * Check if we've already found this scancode. This takes
  484. * quadratic time, but it doesn't matter unless the list
  485. * of extra keys gets very long.
  486. */
  487. if (dmi_results.keymap_size &&
  488. have_scancode(entry->code | (0x0010 << 16),
  489. keymap, dmi_results.keymap_size)
  490. )
  491. continue;
  492. keymap[pos] = *entry;
  493. keymap[pos].code |= (0x0010 << 16);
  494. pos++;
  495. }
  496. /* Append table with events of type 0x0011 */
  497. for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0011); i++) {
  498. keymap[pos] = dell_wmi_keymap_type_0011[i];
  499. keymap[pos].code |= (0x0011 << 16);
  500. pos++;
  501. }
  502. /* Append table with events of type 0x0012 */
  503. for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0012); i++) {
  504. keymap[pos] = dell_wmi_keymap_type_0012[i];
  505. keymap[pos].code |= (0x0012 << 16);
  506. pos++;
  507. }
  508. /*
  509. * Now append also table with "legacy" events of type 0x0000. Some of
  510. * them are reported also on laptops which have scancodes in DMI.
  511. */
  512. for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0000); i++) {
  513. keymap[pos] = dell_wmi_keymap_type_0000[i];
  514. pos++;
  515. }
  516. keymap[pos].type = KE_END;
  517. err = sparse_keymap_setup(priv->input_dev, keymap, NULL);
  518. /*
  519. * Sparse keymap library makes a copy of keymap so we don't need the
  520. * original one that was allocated.
  521. */
  522. kfree(keymap);
  523. if (err)
  524. goto err_free_dev;
  525. err = input_register_device(priv->input_dev);
  526. if (err)
  527. goto err_free_dev;
  528. return 0;
  529. err_free_dev:
  530. input_free_device(priv->input_dev);
  531. return err;
  532. }
  533. static void dell_wmi_input_destroy(struct wmi_device *wdev)
  534. {
  535. struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
  536. input_unregister_device(priv->input_dev);
  537. }
  538. /*
  539. * According to Dell SMBIOS documentation:
  540. *
  541. * 17 3 Application Program Registration
  542. *
  543. * cbArg1 Application ID 1 = 0x00010000
  544. * cbArg2 Application ID 2
  545. * QUICKSET/DCP = 0x51534554 "QSET"
  546. * ALS Driver = 0x416c7353 "AlsS"
  547. * Latitude ON = 0x4c6f6e52 "LonR"
  548. * cbArg3 Application version or revision number
  549. * cbArg4 0 = Unregister application
  550. * 1 = Register application
  551. * cbRes1 Standard return codes (0, -1, -2)
  552. */
  553. static int dell_wmi_events_set_enabled(bool enable)
  554. {
  555. struct calling_interface_buffer *buffer;
  556. int ret;
  557. buffer = kzalloc(sizeof(struct calling_interface_buffer), GFP_KERNEL);
  558. if (!buffer)
  559. return -ENOMEM;
  560. buffer->cmd_class = CLASS_INFO;
  561. buffer->cmd_select = SELECT_APP_REGISTRATION;
  562. buffer->input[0] = 0x10000;
  563. buffer->input[1] = 0x51534554;
  564. buffer->input[3] = enable;
  565. ret = dell_smbios_call(buffer);
  566. if (ret == 0)
  567. ret = buffer->output[0];
  568. kfree(buffer);
  569. return dell_smbios_error(ret);
  570. }
  571. static int dell_wmi_probe(struct wmi_device *wdev, const void *context)
  572. {
  573. struct dell_wmi_priv *priv;
  574. int ret;
  575. ret = dell_wmi_get_descriptor_valid();
  576. if (ret)
  577. return ret;
  578. priv = devm_kzalloc(
  579. &wdev->dev, sizeof(struct dell_wmi_priv), GFP_KERNEL);
  580. if (!priv)
  581. return -ENOMEM;
  582. dev_set_drvdata(&wdev->dev, priv);
  583. if (!dell_wmi_get_interface_version(&priv->interface_version))
  584. return -EPROBE_DEFER;
  585. return dell_wmi_input_setup(wdev);
  586. }
  587. static int dell_wmi_remove(struct wmi_device *wdev)
  588. {
  589. dell_wmi_input_destroy(wdev);
  590. return 0;
  591. }
  592. static const struct wmi_device_id dell_wmi_id_table[] = {
  593. { .guid_string = DELL_EVENT_GUID },
  594. { },
  595. };
  596. static struct wmi_driver dell_wmi_driver = {
  597. .driver = {
  598. .name = "dell-wmi",
  599. },
  600. .id_table = dell_wmi_id_table,
  601. .probe = dell_wmi_probe,
  602. .remove = dell_wmi_remove,
  603. .notify = dell_wmi_notify,
  604. };
  605. static int __init dell_wmi_init(void)
  606. {
  607. int err;
  608. dmi_check_system(dell_wmi_smbios_list);
  609. if (wmi_requires_smbios_request) {
  610. err = dell_wmi_events_set_enabled(true);
  611. if (err) {
  612. pr_err("Failed to enable WMI events\n");
  613. return err;
  614. }
  615. }
  616. return wmi_driver_register(&dell_wmi_driver);
  617. }
  618. late_initcall(dell_wmi_init);
  619. static void __exit dell_wmi_exit(void)
  620. {
  621. if (wmi_requires_smbios_request)
  622. dell_wmi_events_set_enabled(false);
  623. wmi_driver_unregister(&dell_wmi_driver);
  624. }
  625. module_exit(dell_wmi_exit);
  626. MODULE_DEVICE_TABLE(wmi, dell_wmi_id_table);