dell-wmi.c 20 KB

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