[deliverable/linux.git] / drivers / platform / x86 / dell-wmi.c

/*
 * Dell WMI hotkeys
 *
 * Copyright (C) 2008 Red Hat <mjg@redhat.com>
 * Copyright (C) 2014-2015 Pali Rohár <pali.rohar@gmail.com>
 *
 * Portions based on wistron_btns.c:
 * Copyright (C) 2005 Miloslav Trmac <mitr@volny.cz>
 * Copyright (C) 2005 Bernhard Rosenkraenzer <bero@arklinux.org>
 * Copyright (C) 2005 Dmitry Torokhov <dtor@mail.ru>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/types.h>
#include <linux/input.h>
#include <linux/input/sparse-keymap.h>
#include <linux/acpi.h>
#include <linux/string.h>
#include <linux/dmi.h>
#include <acpi/video.h>

MODULE_AUTHOR("Matthew Garrett <mjg@redhat.com>");
MODULE_AUTHOR("Pali Rohár <pali.rohar@gmail.com>");
MODULE_DESCRIPTION("Dell laptop WMI hotkeys driver");
MODULE_LICENSE("GPL");

#define DELL_EVENT_GUID "9DBB5994-A997-11DA-B012-B622A1EF5492"
#define DELL_DESCRIPTOR_GUID "8D9DDCBC-A997-11DA-B012-B622A1EF5492"

static u32 dell_wmi_interface_version;

MODULE_ALIAS("wmi:"DELL_EVENT_GUID);
MODULE_ALIAS("wmi:"DELL_DESCRIPTOR_GUID);

/*
 * Certain keys are flagged as KE_IGNORE. All of these are either
 * notifications (rather than requests for change) or are also sent
 * via the keyboard controller so should not be sent again.
 */

static const struct key_entry dell_wmi_legacy_keymap[] __initconst = {
	{ KE_IGNORE, 0x003a, { KEY_CAPSLOCK } },

	{ KE_KEY, 0xe045, { KEY_PROG1 } },
	{ KE_KEY, 0xe009, { KEY_EJECTCD } },

	/* These also contain the brightness level at offset 6 */
	{ KE_KEY, 0xe006, { KEY_BRIGHTNESSUP } },
	{ KE_KEY, 0xe005, { KEY_BRIGHTNESSDOWN } },

	/* Battery health status button */
	{ KE_KEY, 0xe007, { KEY_BATTERY } },

	/* Radio devices state change */
	{ KE_IGNORE, 0xe008, { KEY_RFKILL } },

	/* The next device is at offset 6, the active devices are at
	   offset 8 and the attached devices at offset 10 */
	{ KE_KEY, 0xe00b, { KEY_SWITCHVIDEOMODE } },

	{ KE_IGNORE, 0xe00c, { KEY_KBDILLUMTOGGLE } },

	/* BIOS error detected */
	{ KE_IGNORE, 0xe00d, { KEY_RESERVED } },

	/* Wifi Catcher */
	{ KE_KEY, 0xe011, {KEY_PROG2 } },

	/* Ambient light sensor toggle */
	{ KE_IGNORE, 0xe013, { KEY_RESERVED } },

	{ KE_IGNORE, 0xe020, { KEY_MUTE } },

	/* Shortcut and audio panel keys */
	{ KE_IGNORE, 0xe025, { KEY_RESERVED } },
	{ KE_IGNORE, 0xe026, { KEY_RESERVED } },

	{ KE_IGNORE, 0xe02e, { KEY_VOLUMEDOWN } },
	{ KE_IGNORE, 0xe030, { KEY_VOLUMEUP } },
	{ KE_IGNORE, 0xe033, { KEY_KBDILLUMUP } },
	{ KE_IGNORE, 0xe034, { KEY_KBDILLUMDOWN } },
	{ KE_IGNORE, 0xe03a, { KEY_CAPSLOCK } },
	{ KE_IGNORE, 0xe045, { KEY_NUMLOCK } },
	{ KE_IGNORE, 0xe046, { KEY_SCROLLLOCK } },
	{ KE_IGNORE, 0xe0f7, { KEY_MUTE } },
	{ KE_IGNORE, 0xe0f8, { KEY_VOLUMEDOWN } },
	{ KE_IGNORE, 0xe0f9, { KEY_VOLUMEUP } },
	{ KE_END, 0 }
};

static bool dell_new_hk_type;

struct dell_bios_keymap_entry {
	u16 scancode;
	u16 keycode;
};

struct dell_bios_hotkey_table {
	struct dmi_header header;
	struct dell_bios_keymap_entry keymap[];

};

struct dell_dmi_results {
	int err;
	struct key_entry *keymap;
};

/* Uninitialized entries here are KEY_RESERVED == 0. */
static const u16 bios_to_linux_keycode[256] __initconst = {
	[0]	= KEY_MEDIA,
	[1]	= KEY_NEXTSONG,
	[2]	= KEY_PLAYPAUSE,
	[3]	= KEY_PREVIOUSSONG,
	[4]	= KEY_STOPCD,
	[5]	= KEY_UNKNOWN,
	[6]	= KEY_UNKNOWN,
	[7]	= KEY_UNKNOWN,
	[8]	= KEY_WWW,
	[9]	= KEY_UNKNOWN,
	[10]	= KEY_VOLUMEDOWN,
	[11]	= KEY_MUTE,
	[12]	= KEY_VOLUMEUP,
	[13]	= KEY_UNKNOWN,
	[14]	= KEY_BATTERY,
	[15]	= KEY_EJECTCD,
	[16]	= KEY_UNKNOWN,
	[17]	= KEY_SLEEP,
	[18]	= KEY_PROG1,
	[19]	= KEY_BRIGHTNESSDOWN,
	[20]	= KEY_BRIGHTNESSUP,
	[21]	= KEY_UNKNOWN,
	[22]	= KEY_KBDILLUMTOGGLE,
	[23]	= KEY_UNKNOWN,
	[24]	= KEY_SWITCHVIDEOMODE,
	[25]	= KEY_UNKNOWN,
	[26]	= KEY_UNKNOWN,
	[27]	= KEY_SWITCHVIDEOMODE,
	[28]	= KEY_UNKNOWN,
	[29]	= KEY_UNKNOWN,
	[30]	= KEY_PROG2,
	[31]	= KEY_UNKNOWN,
	[32]	= KEY_UNKNOWN,
	[33]	= KEY_UNKNOWN,
	[34]	= KEY_UNKNOWN,
	[35]	= KEY_UNKNOWN,
	[36]	= KEY_UNKNOWN,
	[37]	= KEY_UNKNOWN,
	[38]	= KEY_MICMUTE,
	[255]	= KEY_PROG3,
};

static struct input_dev *dell_wmi_input_dev;

static void dell_wmi_process_key(int reported_key)
{
	const struct key_entry *key;

	key = sparse_keymap_entry_from_scancode(dell_wmi_input_dev,
						reported_key);
	if (!key) {
		pr_info("Unknown key with scancode 0x%x pressed\n",
			reported_key);
		return;
	}

	pr_debug("Key %x pressed\n", reported_key);

	/* Don't report brightness notifications that will also come via ACPI */
	if ((key->keycode == KEY_BRIGHTNESSUP ||
	     key->keycode == KEY_BRIGHTNESSDOWN) &&
	    acpi_video_handles_brightness_key_presses())
		return;

	sparse_keymap_report_entry(dell_wmi_input_dev, key, 1, true);
}

static void dell_wmi_notify(u32 value, void *context)
{
	struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
	union acpi_object *obj;
	acpi_status status;
	acpi_size buffer_size;
	u16 *buffer_entry, *buffer_end;
	int len, i;

	status = wmi_get_event_data(value, &response);
	if (status != AE_OK) {
		pr_warn("bad event status 0x%x\n", status);
		return;
	}

	obj = (union acpi_object *)response.pointer;
	if (!obj) {
		pr_warn("no response\n");
		return;
	}

	if (obj->type != ACPI_TYPE_BUFFER) {
		pr_warn("bad response type %x\n", obj->type);
		kfree(obj);
		return;
	}

	pr_debug("Received WMI event (%*ph)\n",
		obj->buffer.length, obj->buffer.pointer);

	buffer_entry = (u16 *)obj->buffer.pointer;
	buffer_size = obj->buffer.length/2;

	if (!dell_new_hk_type) {
		if (buffer_size >= 3 && buffer_entry[1] == 0x0)
			dell_wmi_process_key(buffer_entry[2]);
		else if (buffer_size >= 2)
			dell_wmi_process_key(buffer_entry[1]);
		else
			pr_info("Received unknown WMI event\n");
		kfree(obj);
		return;
	}

	buffer_end = buffer_entry + buffer_size;

	/*
	 * BIOS/ACPI on devices with WMI interface version 0 does not clear
	 * buffer before filling it. So next time when BIOS/ACPI send WMI event
	 * which is smaller as previous then it contains garbage in buffer from
	 * previous event.
	 *
	 * BIOS/ACPI on devices with WMI interface version 1 clears buffer and
	 * sometimes send more events in buffer at one call.
	 *
	 * So to prevent reading garbage from buffer we will process only first
	 * one event on devices with WMI interface version 0.
	 */
	if (dell_wmi_interface_version == 0 && buffer_entry < buffer_end)
		if (buffer_end > buffer_entry + buffer_entry[0] + 1)
			buffer_end = buffer_entry + buffer_entry[0] + 1;

	while (buffer_entry < buffer_end) {

		len = buffer_entry[0];
		if (len == 0)
			break;

		len++;

		if (buffer_entry + len > buffer_end) {
			pr_warn("Invalid length of WMI event\n");
			break;
		}

		pr_debug("Process buffer (%*ph)\n", len*2, buffer_entry);

		switch (buffer_entry[1]) {
		case 0x00:
			for (i = 2; i < len; ++i) {
				switch (buffer_entry[i]) {
				case 0xe043:
					/* NIC Link is Up */
					pr_debug("NIC Link is Up\n");
					break;
				case 0xe044:
					/* NIC Link is Down */
					pr_debug("NIC Link is Down\n");
					break;
				case 0xe045:
					/* Unknown event but defined in DSDT */
				default:
					/* Unknown event */
					pr_info("Unknown WMI event type 0x00: "
						"0x%x\n", (int)buffer_entry[i]);
					break;
				}
			}
			break;
		case 0x10:
			/* Keys pressed */
			for (i = 2; i < len; ++i)
				dell_wmi_process_key(buffer_entry[i]);
			break;
		case 0x11:
			for (i = 2; i < len; ++i) {
				switch (buffer_entry[i]) {
				case 0xfff0:
					/* Battery unplugged */
					pr_debug("Battery unplugged\n");
					break;
				case 0xfff1:
					/* Battery inserted */
					pr_debug("Battery inserted\n");
					break;
				case 0x01e1:
				case 0x02ea:
				case 0x02eb:
				case 0x02ec:
				case 0x02f6:
					/* Keyboard backlight level changed */
					pr_debug("Keyboard backlight level "
						 "changed\n");
					break;
				default:
					/* Unknown event */
					pr_info("Unknown WMI event type 0x11: "
						"0x%x\n", (int)buffer_entry[i]);
					break;
				}
			}
			break;
		default:
			/* Unknown event */
			pr_info("Unknown WMI event type 0x%x\n",
				(int)buffer_entry[1]);
			break;
		}

		buffer_entry += len;

	}

	kfree(obj);
}

static void __init handle_dmi_entry(const struct dmi_header *dm,
				    void *opaque)
{
	struct dell_dmi_results *results = opaque;
	struct dell_bios_hotkey_table *table;
	struct key_entry *keymap;
	int hotkey_num, i;

	if (results->err || results->keymap)
		return;		/* We already found the hotkey table. */

	if (dm->type != 0xb2 || dm->length <= 6)
		return;

	table = container_of(dm, struct dell_bios_hotkey_table, header);

	hotkey_num = (table->header.length - 4) /
				sizeof(struct dell_bios_keymap_entry);

	keymap = kcalloc(hotkey_num + 1, sizeof(struct key_entry), GFP_KERNEL);
	if (!keymap) {
		results->err = -ENOMEM;
		return;
	}

	for (i = 0; i < hotkey_num; i++) {
		const struct dell_bios_keymap_entry *bios_entry =
					&table->keymap[i];

		/* Uninitialized entries are 0 aka KEY_RESERVED. */
		u16 keycode = (bios_entry->keycode <
			       ARRAY_SIZE(bios_to_linux_keycode)) ?
			bios_to_linux_keycode[bios_entry->keycode] :
			KEY_RESERVED;

		/*
		 * Log if we find an entry in the DMI table that we don't
		 * understand.  If this happens, we should figure out what
		 * the entry means and add it to bios_to_linux_keycode.
		 */
		if (keycode == KEY_RESERVED) {
			pr_info("firmware scancode 0x%x maps to unrecognized keycode 0x%x\n",
				bios_entry->scancode, bios_entry->keycode);
			continue;
		}

		if (keycode == KEY_KBDILLUMTOGGLE)
			keymap[i].type = KE_IGNORE;
		else
			keymap[i].type = KE_KEY;
		keymap[i].code = bios_entry->scancode;
		keymap[i].keycode = keycode;
	}

	keymap[hotkey_num].type = KE_END;

	results->keymap = keymap;
}

static int __init dell_wmi_input_setup(void)
{
	struct dell_dmi_results dmi_results = {};
	int err;

	dell_wmi_input_dev = input_allocate_device();
	if (!dell_wmi_input_dev)
		return -ENOMEM;

	dell_wmi_input_dev->name = "Dell WMI hotkeys";
	dell_wmi_input_dev->phys = "wmi/input0";
	dell_wmi_input_dev->id.bustype = BUS_HOST;

	if (dmi_walk(handle_dmi_entry, &dmi_results)) {
		/*
		 * Historically, dell-wmi ignored dmi_walk errors.  A failure
		 * is certainly surprising, but it probably just indicates
		 * a very old laptop.
		 */
		pr_warn("no DMI; using the old-style hotkey interface\n");
	}

	if (dmi_results.err) {
		err = dmi_results.err;
		goto err_free_dev;
	}

	if (dmi_results.keymap) {
		dell_new_hk_type = true;

		err = sparse_keymap_setup(dell_wmi_input_dev,
					  dmi_results.keymap, NULL);

		/*
		 * Sparse keymap library makes a copy of keymap so we
		 * don't need the original one that was allocated.
		 */
		kfree(dmi_results.keymap);
	} else {
		err = sparse_keymap_setup(dell_wmi_input_dev,
					  dell_wmi_legacy_keymap, NULL);
	}
	if (err)
		goto err_free_dev;

	err = input_register_device(dell_wmi_input_dev);
	if (err)
		goto err_free_keymap;

	return 0;

 err_free_keymap:
	sparse_keymap_free(dell_wmi_input_dev);
 err_free_dev:
	input_free_device(dell_wmi_input_dev);
	return err;
}

static void dell_wmi_input_destroy(void)
{
	sparse_keymap_free(dell_wmi_input_dev);
	input_unregister_device(dell_wmi_input_dev);
}

/*
 * Descriptor buffer is 128 byte long and contains:
 *
 *       Name             Offset  Length  Value
 * Vendor Signature          0       4    "DELL"
 * Object Signature          4       4    " WMI"
 * WMI Interface Version     8       4    <version>
 * WMI buffer length        12       4    4096
 */
static int __init dell_wmi_check_descriptor_buffer(void)
{
	struct acpi_buffer out = { ACPI_ALLOCATE_BUFFER, NULL };
	union acpi_object *obj;
	acpi_status status;
	u32 *buffer;

	status = wmi_query_block(DELL_DESCRIPTOR_GUID, 0, &out);
	if (ACPI_FAILURE(status)) {
		pr_err("Cannot read Dell descriptor buffer - %d\n", status);
		return status;
	}

	obj = (union acpi_object *)out.pointer;
	if (!obj) {
		pr_err("Dell descriptor buffer is empty\n");
		return -EINVAL;
	}

	if (obj->type != ACPI_TYPE_BUFFER) {
		pr_err("Cannot read Dell descriptor buffer\n");
		kfree(obj);
		return -EINVAL;
	}

	if (obj->buffer.length != 128) {
		pr_err("Dell descriptor buffer has invalid length (%d)\n",
			obj->buffer.length);
		if (obj->buffer.length < 16) {
			kfree(obj);
			return -EINVAL;
		}
	}

	buffer = (u32 *)obj->buffer.pointer;

	if (buffer[0] != 0x4C4C4544 && buffer[1] != 0x494D5720)
		pr_warn("Dell descriptor buffer has invalid signature (%*ph)\n",
			8, buffer);

	if (buffer[2] != 0 && buffer[2] != 1)
		pr_warn("Dell descriptor buffer has unknown version (%d)\n",
			buffer[2]);

	if (buffer[3] != 4096)
		pr_warn("Dell descriptor buffer has invalid buffer length (%d)\n",
			buffer[3]);

	dell_wmi_interface_version = buffer[2];

	pr_info("Detected Dell WMI interface version %u\n",
		dell_wmi_interface_version);

	kfree(obj);
	return 0;
}

static int __init dell_wmi_init(void)
{
	int err;
	acpi_status status;

	if (!wmi_has_guid(DELL_EVENT_GUID) ||
	    !wmi_has_guid(DELL_DESCRIPTOR_GUID)) {
		pr_warn("Dell WMI GUID were not found\n");
		return -ENODEV;
	}

	err = dell_wmi_check_descriptor_buffer();
	if (err)
		return err;

	err = dell_wmi_input_setup();
	if (err)
		return err;

	status = wmi_install_notify_handler(DELL_EVENT_GUID,
					 dell_wmi_notify, NULL);
	if (ACPI_FAILURE(status)) {
		dell_wmi_input_destroy();
		pr_err("Unable to register notify handler - %d\n", status);
		return -ENODEV;
	}

	return 0;
}
module_init(dell_wmi_init);

static void __exit dell_wmi_exit(void)
{
	wmi_remove_notify_handler(DELL_EVENT_GUID);
	dell_wmi_input_destroy();
}
module_exit(dell_wmi_exit);
Commit	Line	Data
0b3f6109 MG	1	/*
	2	* Dell WMI hotkeys
	3	*
	4	* Copyright (C) 2008 Red Hat <mjg@redhat.com>
595773a4	5	* Copyright (C) 2014-2015 Pali Rohár <pali.rohar@gmail.com>
0b3f6109 MG	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
eb889524 JP	27	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
eb889524 JP	28
0b3f6109 MG	29	#include <linux/kernel.h>
	30	#include <linux/module.h>
	31	#include <linux/init.h>
5a0e3ad6	32	#include <linux/slab.h>
0b3f6109 MG	33	#include <linux/types.h>
0b3f6109 MG	34	#include <linux/input.h>
890a7c8e	35	#include <linux/input/sparse-keymap.h>
0b3f6109 MG	36	#include <linux/acpi.h>
0b3f6109 MG	37	#include <linux/string.h>
5ea25597	38	#include <linux/dmi.h>
18bd7696	39	#include <acpi/video.h>
0b3f6109 MG	40
0b3f6109 MG	41	MODULE_AUTHOR("Matthew Garrett <mjg@redhat.com>");
595773a4	42	MODULE_AUTHOR("Pali Rohár <pali.rohar@gmail.com>");
0b3f6109 MG	43	MODULE_DESCRIPTION("Dell laptop WMI hotkeys driver");
	44	MODULE_LICENSE("GPL");
	45
	46	#define DELL_EVENT_GUID "9DBB5994-A997-11DA-B012-B622A1EF5492"
595773a4	47	#define DELL_DESCRIPTOR_GUID "8D9DDCBC-A997-11DA-B012-B622A1EF5492"
0b3f6109	48
595773a4	49	static u32 dell_wmi_interface_version;
0b3f6109 MG	50
0b3f6109 MG	51	MODULE_ALIAS("wmi:"DELL_EVENT_GUID);
595773a4	52	MODULE_ALIAS("wmi:"DELL_DESCRIPTOR_GUID);
0b3f6109	53
5cab0098 ML	54	/*
	55	* Certain keys are flagged as KE_IGNORE. All of these are either
	56	* notifications (rather than requests for change) or are also sent
	57	* via the keyboard controller so should not be sent again.
	58	*/
0b3f6109	59
890a7c8e	60	static const struct key_entry dell_wmi_legacy_keymap[] __initconst = {
f1566f0d SF	61	{ KE_IGNORE, 0x003a, { KEY_CAPSLOCK } },
f1566f0d SF	62
890a7c8e DT	63	{ KE_KEY, 0xe045, { KEY_PROG1 } },
890a7c8e DT	64	{ KE_KEY, 0xe009, { KEY_EJECTCD } },
5cab0098 ML	65
5cab0098 ML	66	/* These also contain the brightness level at offset 6 */
890a7c8e DT	67	{ KE_KEY, 0xe006, { KEY_BRIGHTNESSUP } },
890a7c8e DT	68	{ KE_KEY, 0xe005, { KEY_BRIGHTNESSDOWN } },
5cab0098 ML	69
5cab0098 ML	70	/* Battery health status button */
890a7c8e	71	{ KE_KEY, 0xe007, { KEY_BATTERY } },
5cab0098	72
8f8d75eb GM	73	/* Radio devices state change */
8f8d75eb GM	74	{ KE_IGNORE, 0xe008, { KEY_RFKILL } },
5cab0098 ML	75
	76	/* The next device is at offset 6, the active devices are at
	77	offset 8 and the attached devices at offset 10 */
890a7c8e	78	{ KE_KEY, 0xe00b, { KEY_SWITCHVIDEOMODE } },
5cab0098	79
890a7c8e	80	{ KE_IGNORE, 0xe00c, { KEY_KBDILLUMTOGGLE } },
5cab0098 ML	81
5cab0098 ML	82	/* BIOS error detected */
890a7c8e	83	{ KE_IGNORE, 0xe00d, { KEY_RESERVED } },
5cab0098 ML	84
5cab0098 ML	85	/* Wifi Catcher */
890a7c8e	86	{ KE_KEY, 0xe011, {KEY_PROG2 } },
5cab0098 ML	87
5cab0098 ML	88	/* Ambient light sensor toggle */
890a7c8e DT	89	{ KE_IGNORE, 0xe013, { KEY_RESERVED } },
	90
	91	{ KE_IGNORE, 0xe020, { KEY_MUTE } },
f1566f0d SF	92
	93	/* Shortcut and audio panel keys */
	94	{ KE_IGNORE, 0xe025, { KEY_RESERVED } },
	95	{ KE_IGNORE, 0xe026, { KEY_RESERVED } },
	96
890a7c8e DT	97	{ KE_IGNORE, 0xe02e, { KEY_VOLUMEDOWN } },
	98	{ KE_IGNORE, 0xe030, { KEY_VOLUMEUP } },
	99	{ KE_IGNORE, 0xe033, { KEY_KBDILLUMUP } },
	100	{ KE_IGNORE, 0xe034, { KEY_KBDILLUMDOWN } },
	101	{ KE_IGNORE, 0xe03a, { KEY_CAPSLOCK } },
	102	{ KE_IGNORE, 0xe045, { KEY_NUMLOCK } },
	103	{ KE_IGNORE, 0xe046, { KEY_SCROLLLOCK } },
f1566f0d SF	104	{ KE_IGNORE, 0xe0f7, { KEY_MUTE } },
	105	{ KE_IGNORE, 0xe0f8, { KEY_VOLUMEDOWN } },
	106	{ KE_IGNORE, 0xe0f9, { KEY_VOLUMEUP } },
890a7c8e	107	{ KE_END, 0 }
0b3f6109 MG	108	};
0b3f6109 MG	109
5ea25597 RK	110	static bool dell_new_hk_type;
5ea25597 RK	111
890a7c8e	112	struct dell_bios_keymap_entry {
5ea25597 RK	113	u16 scancode;
	114	u16 keycode;
	115	};
	116
890a7c8e	117	struct dell_bios_hotkey_table {
5ea25597	118	struct dmi_header header;
890a7c8e	119	struct dell_bios_keymap_entry keymap[];
5ea25597 RK	120
	121	};
	122
18b6f80f AL	123	struct dell_dmi_results {
	124	int err;
	125	struct key_entry *keymap;
	126	};
5ea25597	127
cbc61f11	128	/* Uninitialized entries here are KEY_RESERVED == 0. */
890a7c8e	129	static const u16 bios_to_linux_keycode[256] __initconst = {
394cb778 AL	130	[0] = KEY_MEDIA,
	131	[1] = KEY_NEXTSONG,
	132	[2] = KEY_PLAYPAUSE,
	133	[3] = KEY_PREVIOUSSONG,
	134	[4] = KEY_STOPCD,
	135	[5] = KEY_UNKNOWN,
	136	[6] = KEY_UNKNOWN,
	137	[7] = KEY_UNKNOWN,
	138	[8] = KEY_WWW,
	139	[9] = KEY_UNKNOWN,
	140	[10] = KEY_VOLUMEDOWN,
	141	[11] = KEY_MUTE,
	142	[12] = KEY_VOLUMEUP,
	143	[13] = KEY_UNKNOWN,
	144	[14] = KEY_BATTERY,
	145	[15] = KEY_EJECTCD,
	146	[16] = KEY_UNKNOWN,
	147	[17] = KEY_SLEEP,
	148	[18] = KEY_PROG1,
	149	[19] = KEY_BRIGHTNESSDOWN,
	150	[20] = KEY_BRIGHTNESSUP,
	151	[21] = KEY_UNKNOWN,
	152	[22] = KEY_KBDILLUMTOGGLE,
	153	[23] = KEY_UNKNOWN,
	154	[24] = KEY_SWITCHVIDEOMODE,
	155	[25] = KEY_UNKNOWN,
	156	[26] = KEY_UNKNOWN,
	157	[27] = KEY_SWITCHVIDEOMODE,
	158	[28] = KEY_UNKNOWN,
	159	[29] = KEY_UNKNOWN,
	160	[30] = KEY_PROG2,
	161	[31] = KEY_UNKNOWN,
	162	[32] = KEY_UNKNOWN,
	163	[33] = KEY_UNKNOWN,
	164	[34] = KEY_UNKNOWN,
	165	[35] = KEY_UNKNOWN,
	166	[36] = KEY_UNKNOWN,
	167	[37] = KEY_UNKNOWN,
	168	[38] = KEY_MICMUTE,
	169	[255] = KEY_PROG3,
5ea25597 RK	170	};
5ea25597 RK	171
0b3f6109 MG	172	static struct input_dev *dell_wmi_input_dev;
0b3f6109 MG	173
83fc44c3 PR	174	static void dell_wmi_process_key(int reported_key)
	175	{
	176	const struct key_entry *key;
	177
	178	key = sparse_keymap_entry_from_scancode(dell_wmi_input_dev,
	179	reported_key);
	180	if (!key) {
cbc61f11 AL	181	pr_info("Unknown key with scancode 0x%x pressed\n",
cbc61f11 AL	182	reported_key);
83fc44c3 PR	183	return;
	184	}
	185
	186	pr_debug("Key %x pressed\n", reported_key);
	187
	188	/* Don't report brightness notifications that will also come via ACPI */
	189	if ((key->keycode == KEY_BRIGHTNESSUP \|\|
61679c72 HG	190	key->keycode == KEY_BRIGHTNESSDOWN) &&
61679c72 HG	191	acpi_video_handles_brightness_key_presses())
83fc44c3 PR	192	return;
	193
	194	sparse_keymap_report_entry(dell_wmi_input_dev, key, 1, true);
	195	}
	196
0b3f6109 MG	197	static void dell_wmi_notify(u32 value, void *context)
	198	{
	199	struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
0b3f6109	200	union acpi_object *obj;
fda11e61	201	acpi_status status;
83fc44c3 PR	202	acpi_size buffer_size;
	203	u16 buffer_entry, buffer_end;
	204	int len, i;
0b3f6109	205
fda11e61 LB	206	status = wmi_get_event_data(value, &response);
fda11e61 LB	207	if (status != AE_OK) {
83fc44c3	208	pr_warn("bad event status 0x%x\n", status);
fda11e61 LB	209	return;
fda11e61 LB	210	}
0b3f6109 MG	211
0b3f6109 MG	212	obj = (union acpi_object *)response.pointer;
83fc44c3 PR	213	if (!obj) {
	214	pr_warn("no response\n");
	215	return;
	216	}
0b3f6109	217
83fc44c3 PR	218	if (obj->type != ACPI_TYPE_BUFFER) {
	219	pr_warn("bad response type %x\n", obj->type);
	220	kfree(obj);
	221	return;
	222	}
	223
	224	pr_debug("Received WMI event (%*ph)\n",
	225	obj->buffer.length, obj->buffer.pointer);
5ea25597	226
83fc44c3 PR	227	buffer_entry = (u16 *)obj->buffer.pointer;
	228	buffer_size = obj->buffer.length/2;
	229
	230	if (!dell_new_hk_type) {
	231	if (buffer_size >= 3 && buffer_entry[1] == 0x0)
	232	dell_wmi_process_key(buffer_entry[2]);
a666b6ff	233	else if (buffer_size >= 2)
83fc44c3 PR	234	dell_wmi_process_key(buffer_entry[1]);
83fc44c3 PR	235	else
a666b6ff	236	pr_info("Received unknown WMI event\n");
83fc44c3 PR	237	kfree(obj);
	238	return;
	239	}
	240
	241	buffer_end = buffer_entry + buffer_size;
	242
481fe5be PR	243	/*
	244	* BIOS/ACPI on devices with WMI interface version 0 does not clear
	245	* buffer before filling it. So next time when BIOS/ACPI send WMI event
	246	* which is smaller as previous then it contains garbage in buffer from
	247	* previous event.
	248	*
	249	* BIOS/ACPI on devices with WMI interface version 1 clears buffer and
	250	* sometimes send more events in buffer at one call.
	251	*
	252	* So to prevent reading garbage from buffer we will process only first
	253	* one event on devices with WMI interface version 0.
	254	*/
	255	if (dell_wmi_interface_version == 0 && buffer_entry < buffer_end)
	256	if (buffer_end > buffer_entry + buffer_entry[0] + 1)
	257	buffer_end = buffer_entry + buffer_entry[0] + 1;
	258
83fc44c3 PR	259	while (buffer_entry < buffer_end) {
	260
	261	len = buffer_entry[0];
	262	if (len == 0)
	263	break;
	264
	265	len++;
	266
	267	if (buffer_entry + len > buffer_end) {
	268	pr_warn("Invalid length of WMI event\n");
	269	break;
a666b6ff	270	}
5ea25597	271
83fc44c3 PR	272	pr_debug("Process buffer (%ph)\n", len2, buffer_entry);
	273
	274	switch (buffer_entry[1]) {
	275	case 0x00:
	276	for (i = 2; i < len; ++i) {
	277	switch (buffer_entry[i]) {
	278	case 0xe043:
	279	/* NIC Link is Up */
	280	pr_debug("NIC Link is Up\n");
	281	break;
	282	case 0xe044:
	283	/* NIC Link is Down */
	284	pr_debug("NIC Link is Down\n");
	285	break;
	286	case 0xe045:
	287	/* Unknown event but defined in DSDT */
	288	default:
	289	/* Unknown event */
	290	pr_info("Unknown WMI event type 0x00: "
	291	"0x%x\n", (int)buffer_entry[i]);
	292	break;
	293	}
	294	}
	295	break;
	296	case 0x10:
	297	/* Keys pressed */
	298	for (i = 2; i < len; ++i)
	299	dell_wmi_process_key(buffer_entry[i]);
	300	break;
	301	case 0x11:
	302	for (i = 2; i < len; ++i) {
	303	switch (buffer_entry[i]) {
	304	case 0xfff0:
	305	/* Battery unplugged */
	306	pr_debug("Battery unplugged\n");
	307	break;
	308	case 0xfff1:
	309	/* Battery inserted */
	310	pr_debug("Battery inserted\n");
	311	break;
	312	case 0x01e1:
	313	case 0x02ea:
	314	case 0x02eb:
	315	case 0x02ec:
	316	case 0x02f6:
	317	/* Keyboard backlight level changed */
	318	pr_debug("Keyboard backlight level "
	319	"changed\n");
	320	break;
	321	default:
	322	/* Unknown event */
	323	pr_info("Unknown WMI event type 0x11: "
	324	"0x%x\n", (int)buffer_entry[i]);
	325	break;
	326	}
	327	}
	328	break;
	329	default:
	330	/* Unknown event */
	331	pr_info("Unknown WMI event type 0x%x\n",
	332	(int)buffer_entry[1]);
	333	break;
5ea25597	334	}
83fc44c3 PR	335
	336	buffer_entry += len;
	337
0b3f6109	338	}
83fc44c3	339
3e9b988e	340	kfree(obj);
0b3f6109 MG	341	}
0b3f6109 MG	342
18b6f80f AL	343	static void __init handle_dmi_entry(const struct dmi_header *dm,
18b6f80f AL	344	void *opaque)
5ea25597	345	{
18b6f80f AL	346	struct dell_dmi_results *results = opaque;
18b6f80f AL	347	struct dell_bios_hotkey_table *table;
890a7c8e	348	struct key_entry *keymap;
18b6f80f AL	349	int hotkey_num, i;
	350
	351	if (results->err \|\| results->keymap)
	352	return; /* We already found the hotkey table. */
	353
	354	if (dm->type != 0xb2 \|\| dm->length <= 6)
	355	return;
	356
	357	table = container_of(dm, struct dell_bios_hotkey_table, header);
	358
	359	hotkey_num = (table->header.length - 4) /
	360	sizeof(struct dell_bios_keymap_entry);
5ea25597	361
890a7c8e	362	keymap = kcalloc(hotkey_num + 1, sizeof(struct key_entry), GFP_KERNEL);
18b6f80f AL	363	if (!keymap) {
	364	results->err = -ENOMEM;
	365	return;
	366	}
5ea25597 RK	367
5ea25597 RK	368	for (i = 0; i < hotkey_num; i++) {
890a7c8e	369	const struct dell_bios_keymap_entry *bios_entry =
18b6f80f	370	&table->keymap[i];
cbc61f11 AL	371
	372	/* Uninitialized entries are 0 aka KEY_RESERVED. */
	373	u16 keycode = (bios_entry->keycode <
	374	ARRAY_SIZE(bios_to_linux_keycode)) ?
	375	bios_to_linux_keycode[bios_entry->keycode] :
	376	KEY_RESERVED;
	377
	378	/*
	379	* Log if we find an entry in the DMI table that we don't
	380	* understand. If this happens, we should figure out what
	381	* the entry means and add it to bios_to_linux_keycode.
	382	*/
	383	if (keycode == KEY_RESERVED) {
	384	pr_info("firmware scancode 0x%x maps to unrecognized keycode 0x%x\n",
	385	bios_entry->scancode, bios_entry->keycode);
	386	continue;
	387	}
8cb8e63b GM	388
	389	if (keycode == KEY_KBDILLUMTOGGLE)
	390	keymap[i].type = KE_IGNORE;
	391	else
	392	keymap[i].type = KE_KEY;
	393	keymap[i].code = bios_entry->scancode;
	394	keymap[i].keycode = keycode;
5ea25597 RK	395	}
5ea25597 RK	396
890a7c8e	397	keymap[hotkey_num].type = KE_END;
5ea25597	398
18b6f80f	399	results->keymap = keymap;
5ea25597 RK	400	}
5ea25597 RK	401
0b3f6109 MG	402	static int __init dell_wmi_input_setup(void)
0b3f6109 MG	403	{
18b6f80f	404	struct dell_dmi_results dmi_results = {};
0b3f6109 MG	405	int err;
	406
	407	dell_wmi_input_dev = input_allocate_device();
0b3f6109 MG	408	if (!dell_wmi_input_dev)
	409	return -ENOMEM;
	410
	411	dell_wmi_input_dev->name = "Dell WMI hotkeys";
	412	dell_wmi_input_dev->phys = "wmi/input0";
	413	dell_wmi_input_dev->id.bustype = BUS_HOST;
890a7c8e	414
18b6f80f AL	415	if (dmi_walk(handle_dmi_entry, &dmi_results)) {
	416	/*
	417	* Historically, dell-wmi ignored dmi_walk errors. A failure
	418	* is certainly surprising, but it probably just indicates
	419	* a very old laptop.
	420	*/
	421	pr_warn("no DMI; using the old-style hotkey interface\n");
	422	}
	423
	424	if (dmi_results.err) {
	425	err = dmi_results.err;
	426	goto err_free_dev;
	427	}
	428
	429	if (dmi_results.keymap) {
	430	dell_new_hk_type = true;
0b3f6109	431
18b6f80f AL	432	err = sparse_keymap_setup(dell_wmi_input_dev,
18b6f80f AL	433	dmi_results.keymap, NULL);
0b3f6109	434
890a7c8e DT	435	/*
	436	* Sparse keymap library makes a copy of keymap so we
	437	* don't need the original one that was allocated.
	438	*/
18b6f80f	439	kfree(dmi_results.keymap);
890a7c8e DT	440	} else {
	441	err = sparse_keymap_setup(dell_wmi_input_dev,
	442	dell_wmi_legacy_keymap, NULL);
0b3f6109	443	}
890a7c8e DT	444	if (err)
	445	goto err_free_dev;
	446
	447	err = input_register_device(dell_wmi_input_dev);
	448	if (err)
	449	goto err_free_keymap;
0b3f6109 MG	450
0b3f6109 MG	451	return 0;
890a7c8e DT	452
	453	err_free_keymap:
	454	sparse_keymap_free(dell_wmi_input_dev);
	455	err_free_dev:
	456	input_free_device(dell_wmi_input_dev);
	457	return err;
	458	}
	459
	460	static void dell_wmi_input_destroy(void)
	461	{
	462	sparse_keymap_free(dell_wmi_input_dev);
	463	input_unregister_device(dell_wmi_input_dev);
	464	}
	465
595773a4 PR	466	/*
	467	* Descriptor buffer is 128 byte long and contains:
	468	*
	469	* Name Offset Length Value
	470	* Vendor Signature 0 4 "DELL"
	471	* Object Signature 4 4 " WMI"
	472	* WMI Interface Version 8 4 <version>
	473	* WMI buffer length 12 4 4096
	474	*/
	475	static int __init dell_wmi_check_descriptor_buffer(void)
	476	{
	477	struct acpi_buffer out = { ACPI_ALLOCATE_BUFFER, NULL };
	478	union acpi_object *obj;
	479	acpi_status status;
	480	u32 *buffer;
	481
	482	status = wmi_query_block(DELL_DESCRIPTOR_GUID, 0, &out);
	483	if (ACPI_FAILURE(status)) {
	484	pr_err("Cannot read Dell descriptor buffer - %d\n", status);
	485	return status;
	486	}
	487
	488	obj = (union acpi_object *)out.pointer;
	489	if (!obj) {
	490	pr_err("Dell descriptor buffer is empty\n");
	491	return -EINVAL;
	492	}
	493
	494	if (obj->type != ACPI_TYPE_BUFFER) {
	495	pr_err("Cannot read Dell descriptor buffer\n");
	496	kfree(obj);
	497	return -EINVAL;
	498	}
	499
	500	if (obj->buffer.length != 128) {
	501	pr_err("Dell descriptor buffer has invalid length (%d)\n",
	502	obj->buffer.length);
	503	if (obj->buffer.length < 16) {
	504	kfree(obj);
	505	return -EINVAL;
	506	}
	507	}
	508
	509	buffer = (u32 *)obj->buffer.pointer;
	510
	511	if (buffer[0] != 0x4C4C4544 && buffer[1] != 0x494D5720)
	512	pr_warn("Dell descriptor buffer has invalid signature (%*ph)\n",
	513	8, buffer);
	514
	515	if (buffer[2] != 0 && buffer[2] != 1)
	516	pr_warn("Dell descriptor buffer has unknown version (%d)\n",
	517	buffer[2]);
	518
	519	if (buffer[3] != 4096)
	520	pr_warn("Dell descriptor buffer has invalid buffer length (%d)\n",
	521	buffer[3]);
	522
	523	dell_wmi_interface_version = buffer[2];
	524
	525	pr_info("Detected Dell WMI interface version %u\n",
	526	dell_wmi_interface_version);
	527
	528	kfree(obj);
	529	return 0;
530	}
531
0b3f6109 MG	532	static int __init dell_wmi_init(void)
	533	{
	534	int err;
abb631bf	535	acpi_status status;
0b3f6109	536
595773a4 PR	537	if (!wmi_has_guid(DELL_EVENT_GUID) \|\|
	538	!wmi_has_guid(DELL_DESCRIPTOR_GUID)) {
	539	pr_warn("Dell WMI GUID were not found\n");
1fdd407f DT	540	return -ENODEV;
1fdd407f DT	541	}
5ea25597	542
595773a4 PR	543	err = dell_wmi_check_descriptor_buffer();
	544	if (err)
	545	return err;
	546
1fdd407f	547	err = dell_wmi_input_setup();
890a7c8e	548	if (err)
1fdd407f	549	return err;
5ea25597	550
abb631bf	551	status = wmi_install_notify_handler(DELL_EVENT_GUID,
1fdd407f	552	dell_wmi_notify, NULL);
abb631bf	553	if (ACPI_FAILURE(status)) {
890a7c8e	554	dell_wmi_input_destroy();
eb889524	555	pr_err("Unable to register notify handler - %d\n", status);
abb631bf	556	return -ENODEV;
1fdd407f	557	}
0b3f6109 MG	558
	559	return 0;
	560	}
890a7c8e	561	module_init(dell_wmi_init);
0b3f6109 MG	562
	563	static void __exit dell_wmi_exit(void)
	564	{
1fdd407f	565	wmi_remove_notify_handler(DELL_EVENT_GUID);
890a7c8e	566	dell_wmi_input_destroy();
0b3f6109	567	}
0b3f6109	568	module_exit(dell_wmi_exit);