[mirror_ubuntu-artful-kernel.git] / drivers / hid / hid-asus.c

/*
 *  HID driver for Asus notebook built-in keyboard.
 *  Fixes small logical maximum to match usage maximum.
 *
 *  Currently supported devices are:
 *    EeeBook X205TA
 *    VivoBook E200HA
 *
 *  Copyright (c) 2016 Yusuke Fujimaki <usk.fujimaki@gmail.com>
 *
 *  This module based on hid-ortek by
 *  Copyright (c) 2010 Johnathon Harris <jmharris@gmail.com>
 *  Copyright (c) 2011 Jiri Kosina
 *
 *  This module has been updated to add support for Asus i2c touchpad.
 *
 *  Copyright (c) 2016 Brendan McGrath <redmcg@redmandi.dyndns.org>
 *  Copyright (c) 2016 Victor Vlasenko <victor.vlasenko@sysgears.com>
 *  Copyright (c) 2016 Frederik Wenigwieser <frederik.wenigwieser@gmail.com>
 */

/*
 * 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.
 */

#include <linux/hid.h>
#include <linux/module.h>
#include <linux/input/mt.h>

#include "hid-ids.h"

MODULE_AUTHOR("Yusuke Fujimaki <usk.fujimaki@gmail.com>");
MODULE_AUTHOR("Brendan McGrath <redmcg@redmandi.dyndns.org>");
MODULE_AUTHOR("Victor Vlasenko <victor.vlasenko@sysgears.com>");
MODULE_AUTHOR("Frederik Wenigwieser <frederik.wenigwieser@gmail.com>");
MODULE_DESCRIPTION("Asus HID Keyboard and TouchPad");

#define FEATURE_REPORT_ID 0x0d
#define INPUT_REPORT_ID 0x5d
#define FEATURE_KBD_REPORT_ID 0x5a

#define INPUT_REPORT_SIZE 28
#define FEATURE_KBD_REPORT_SIZE 16

#define SUPPORT_KBD_BACKLIGHT BIT(0)

#define MAX_CONTACTS 5

#define MAX_X 2794
#define MAX_Y 1758
#define MAX_TOUCH_MAJOR 8
#define MAX_PRESSURE 128

#define CONTACT_DATA_SIZE 5

#define BTN_LEFT_MASK 0x01
#define CONTACT_TOOL_TYPE_MASK 0x80
#define CONTACT_X_MSB_MASK 0xf0
#define CONTACT_Y_MSB_MASK 0x0f
#define CONTACT_TOUCH_MAJOR_MASK 0x07
#define CONTACT_PRESSURE_MASK 0x7f

#define QUIRK_FIX_NOTEBOOK_REPORT	BIT(0)
#define QUIRK_NO_INIT_REPORTS		BIT(1)
#define QUIRK_SKIP_INPUT_MAPPING	BIT(2)
#define QUIRK_IS_MULTITOUCH		BIT(3)
#define QUIRK_NO_CONSUMER_USAGES	BIT(4)
#define QUIRK_USE_KBD_BACKLIGHT		BIT(5)

#define I2C_KEYBOARD_QUIRKS			(QUIRK_FIX_NOTEBOOK_REPORT | \
						 QUIRK_NO_INIT_REPORTS | \
						 QUIRK_NO_CONSUMER_USAGES)
#define I2C_TOUCHPAD_QUIRKS			(QUIRK_NO_INIT_REPORTS | \
						 QUIRK_SKIP_INPUT_MAPPING | \
						 QUIRK_IS_MULTITOUCH)

#define TRKID_SGN       ((TRKID_MAX + 1) >> 1)

struct asus_kbd_leds {
	struct led_classdev cdev;
	struct hid_device *hdev;
	struct work_struct work;
	unsigned int brightness;
	bool removed;
};

struct asus_drvdata {
	unsigned long quirks;
	struct input_dev *input;
	struct asus_kbd_leds *kbd_backlight;
	bool enable_backlight;
};

static void asus_report_contact_down(struct input_dev *input,
		int toolType, u8 *data)
{
	int touch_major, pressure;
	int x = (data[0] & CONTACT_X_MSB_MASK) << 4 | data[1];
	int y = MAX_Y - ((data[0] & CONTACT_Y_MSB_MASK) << 8 | data[2]);

	if (toolType == MT_TOOL_PALM) {
		touch_major = MAX_TOUCH_MAJOR;
		pressure = MAX_PRESSURE;
	} else {
		touch_major = (data[3] >> 4) & CONTACT_TOUCH_MAJOR_MASK;
		pressure = data[4] & CONTACT_PRESSURE_MASK;
	}

	input_report_abs(input, ABS_MT_POSITION_X, x);
	input_report_abs(input, ABS_MT_POSITION_Y, y);
	input_report_abs(input, ABS_MT_TOUCH_MAJOR, touch_major);
	input_report_abs(input, ABS_MT_PRESSURE, pressure);
}

/* Required for Synaptics Palm Detection */
static void asus_report_tool_width(struct input_dev *input)
{
	struct input_mt *mt = input->mt;
	struct input_mt_slot *oldest;
	int oldid, count, i;

	oldest = NULL;
	oldid = mt->trkid;
	count = 0;

	for (i = 0; i < mt->num_slots; ++i) {
		struct input_mt_slot *ps = &mt->slots[i];
		int id = input_mt_get_value(ps, ABS_MT_TRACKING_ID);

		if (id < 0)
			continue;
		if ((id - oldid) & TRKID_SGN) {
			oldest = ps;
			oldid = id;
		}
		count++;
	}

	if (oldest) {
		input_report_abs(input, ABS_TOOL_WIDTH,
			input_mt_get_value(oldest, ABS_MT_TOUCH_MAJOR));
	}
}

static void asus_report_input(struct input_dev *input, u8 *data)
{
	int i;
	u8 *contactData = data + 2;

	for (i = 0; i < MAX_CONTACTS; i++) {
		bool down = !!(data[1] & BIT(i+3));
		int toolType = contactData[3] & CONTACT_TOOL_TYPE_MASK ?
						MT_TOOL_PALM : MT_TOOL_FINGER;

		input_mt_slot(input, i);
		input_mt_report_slot_state(input, toolType, down);

		if (down) {
			asus_report_contact_down(input, toolType, contactData);
			contactData += CONTACT_DATA_SIZE;
		}
	}

	input_report_key(input, BTN_LEFT, data[1] & BTN_LEFT_MASK);
	asus_report_tool_width(input);

	input_mt_sync_frame(input);
	input_sync(input);
}

static int asus_raw_event(struct hid_device *hdev,
		struct hid_report *report, u8 *data, int size)
{
	struct asus_drvdata *drvdata = hid_get_drvdata(hdev);

	if (drvdata->quirks & QUIRK_IS_MULTITOUCH &&
					 data[0] == INPUT_REPORT_ID &&
						size == INPUT_REPORT_SIZE) {
		asus_report_input(drvdata->input, data);
		return 1;
	}

	return 0;
}

static int asus_kbd_set_report(struct hid_device *hdev, u8 *buf, size_t buf_size)
{
	unsigned char *dmabuf;
	int ret;

	dmabuf = kmemdup(buf, buf_size, GFP_KERNEL);
	if (!dmabuf)
		return -ENOMEM;

	ret = hid_hw_raw_request(hdev, FEATURE_KBD_REPORT_ID, dmabuf,
				 buf_size, HID_FEATURE_REPORT,
				 HID_REQ_SET_REPORT);
	kfree(dmabuf);

	return ret;
}

static int asus_kbd_init(struct hid_device *hdev)
{
	u8 buf[] = { FEATURE_KBD_REPORT_ID, 0x41, 0x53, 0x55, 0x53, 0x20, 0x54,
		     0x65, 0x63, 0x68, 0x2e, 0x49, 0x6e, 0x63, 0x2e, 0x00 };
	int ret;

	ret = asus_kbd_set_report(hdev, buf, sizeof(buf));
	if (ret < 0)
		hid_err(hdev, "Asus failed to send init command: %d\n", ret);

	return ret;
}

static int asus_kbd_get_functions(struct hid_device *hdev,
				  unsigned char *kbd_func)
{
	u8 buf[] = { FEATURE_KBD_REPORT_ID, 0x05, 0x20, 0x31, 0x00, 0x08 };
	u8 *readbuf;
	int ret;

	ret = asus_kbd_set_report(hdev, buf, sizeof(buf));
	if (ret < 0) {
		hid_err(hdev, "Asus failed to send configuration command: %d\n", ret);
		return ret;
	}

	readbuf = kzalloc(FEATURE_KBD_REPORT_SIZE, GFP_KERNEL);
	if (!readbuf)
		return -ENOMEM;

	ret = hid_hw_raw_request(hdev, FEATURE_KBD_REPORT_ID, readbuf,
				 FEATURE_KBD_REPORT_SIZE, HID_FEATURE_REPORT,
				 HID_REQ_GET_REPORT);
	if (ret < 0) {
		hid_err(hdev, "Asus failed to request functions: %d\n", ret);
		kfree(readbuf);
		return ret;
	}

	*kbd_func = readbuf[6];

	kfree(readbuf);
	return ret;
}

static void asus_kbd_backlight_set(struct led_classdev *led_cdev,
				   enum led_brightness brightness)
{
	struct asus_kbd_leds *led = container_of(led_cdev, struct asus_kbd_leds,
						 cdev);
	if (led->brightness == brightness)
		return;

	led->brightness = brightness;
	schedule_work(&led->work);
}

static enum led_brightness asus_kbd_backlight_get(struct led_classdev *led_cdev)
{
	struct asus_kbd_leds *led = container_of(led_cdev, struct asus_kbd_leds,
						 cdev);

	return led->brightness;
}

static void asus_kbd_backlight_work(struct work_struct *work)
{
	struct asus_kbd_leds *led = container_of(work, struct asus_kbd_leds, work);
	u8 buf[] = { FEATURE_KBD_REPORT_ID, 0xba, 0xc5, 0xc4, 0x00 };
	int ret;

	if (led->removed)
		return;

	buf[4] = led->brightness;

	ret = asus_kbd_set_report(led->hdev, buf, sizeof(buf));
	if (ret < 0)
		hid_err(led->hdev, "Asus failed to set keyboard backlight: %d\n", ret);
}

static int asus_kbd_register_leds(struct hid_device *hdev)
{
	struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
	unsigned char kbd_func;
	int ret;

	/* Initialize keyboard */
	ret = asus_kbd_init(hdev);
	if (ret < 0)
		return ret;

	/* Get keyboard functions */
	ret = asus_kbd_get_functions(hdev, &kbd_func);
	if (ret < 0)
		return ret;

	/* Check for backlight support */
	if (!(kbd_func & SUPPORT_KBD_BACKLIGHT))
		return -ENODEV;

	drvdata->kbd_backlight = devm_kzalloc(&hdev->dev,
					      sizeof(struct asus_kbd_leds),
					      GFP_KERNEL);
	if (!drvdata->kbd_backlight)
		return -ENOMEM;

	drvdata->kbd_backlight->removed = false;
	drvdata->kbd_backlight->brightness = 0;
	drvdata->kbd_backlight->hdev = hdev;
	drvdata->kbd_backlight->cdev.name = "asus::kbd_backlight";
	drvdata->kbd_backlight->cdev.max_brightness = 3;
	drvdata->kbd_backlight->cdev.brightness_set = asus_kbd_backlight_set;
	drvdata->kbd_backlight->cdev.brightness_get = asus_kbd_backlight_get;
	INIT_WORK(&drvdata->kbd_backlight->work, asus_kbd_backlight_work);

	ret = devm_led_classdev_register(&hdev->dev, &drvdata->kbd_backlight->cdev);
	if (ret < 0) {
		/* No need to have this still around */
		devm_kfree(&hdev->dev, drvdata->kbd_backlight);
	}

	return ret;
}

static int asus_input_configured(struct hid_device *hdev, struct hid_input *hi)
{
	struct input_dev *input = hi->input;
	struct asus_drvdata *drvdata = hid_get_drvdata(hdev);

	if (drvdata->quirks & QUIRK_IS_MULTITOUCH) {
		int ret;

		input_set_abs_params(input, ABS_MT_POSITION_X, 0, MAX_X, 0, 0);
		input_set_abs_params(input, ABS_MT_POSITION_Y, 0, MAX_Y, 0, 0);
		input_set_abs_params(input, ABS_TOOL_WIDTH, 0, MAX_TOUCH_MAJOR, 0, 0);
		input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0, MAX_TOUCH_MAJOR, 0, 0);
		input_set_abs_params(input, ABS_MT_PRESSURE, 0, MAX_PRESSURE, 0, 0);

		__set_bit(BTN_LEFT, input->keybit);
		__set_bit(INPUT_PROP_BUTTONPAD, input->propbit);

		ret = input_mt_init_slots(input, MAX_CONTACTS, INPUT_MT_POINTER);

		if (ret) {
			hid_err(hdev, "Asus input mt init slots failed: %d\n", ret);
			return ret;
		}
	}

	drvdata->input = input;

	if (drvdata->enable_backlight && asus_kbd_register_leds(hdev))
		hid_warn(hdev, "Failed to initialize backlight.\n");

	return 0;
}

#define asus_map_key_clear(c)	hid_map_usage_clear(hi, usage, bit, \
						    max, EV_KEY, (c))
static int asus_input_mapping(struct hid_device *hdev,
		struct hid_input *hi, struct hid_field *field,
		struct hid_usage *usage, unsigned long **bit,
		int *max)
{
	struct asus_drvdata *drvdata = hid_get_drvdata(hdev);

	if (drvdata->quirks & QUIRK_SKIP_INPUT_MAPPING) {
		/* Don't map anything from the HID report.
		 * We do it all manually in asus_input_configured
		 */
		return -1;
	}

	/* ASUS-specific keyboard hotkeys */
	if ((usage->hid & HID_USAGE_PAGE) == 0xff310000) {
		set_bit(EV_REP, hi->input->evbit);
		switch (usage->hid & HID_USAGE) {
		case 0x10: asus_map_key_clear(KEY_BRIGHTNESSDOWN);	break;
		case 0x20: asus_map_key_clear(KEY_BRIGHTNESSUP);		break;
		case 0x35: asus_map_key_clear(KEY_DISPLAY_OFF);		break;
		case 0x6c: asus_map_key_clear(KEY_SLEEP);		break;
		case 0x82: asus_map_key_clear(KEY_CAMERA);		break;
		case 0x88: asus_map_key_clear(KEY_RFKILL);			break;
		case 0xb5: asus_map_key_clear(KEY_CALC);			break;
		case 0xc4: asus_map_key_clear(KEY_KBDILLUMUP);		break;
		case 0xc5: asus_map_key_clear(KEY_KBDILLUMDOWN);		break;

		/* ASUS touchpad toggle */
		case 0x6b: asus_map_key_clear(KEY_F21);			break;

		/* ROG key */
		case 0x38: asus_map_key_clear(KEY_PROG1);		break;

		/* Fn+C ASUS Splendid */
		case 0xba: asus_map_key_clear(KEY_PROG2);		break;

		/* Fn+Space Power4Gear Hybrid */
		case 0x5c: asus_map_key_clear(KEY_PROG3);		break;

		default:
			/* ASUS lazily declares 256 usages, ignore the rest,
			 * as some make the keyboard appear as a pointer device. */
			return -1;
		}

		/*
		 * Check and enable backlight only on devices with UsagePage ==
		 * 0xff31 to avoid initializing the keyboard firmware multiple
		 * times on devices with multiple HID descriptors but same
		 * PID/VID.
		 */
		if (drvdata->quirks & QUIRK_USE_KBD_BACKLIGHT)
			drvdata->enable_backlight = true;

		return 1;
	}

	if (drvdata->quirks & QUIRK_NO_CONSUMER_USAGES &&
		(usage->hid & HID_USAGE_PAGE) == HID_UP_CONSUMER) {
		switch (usage->hid & HID_USAGE) {
		case 0xe2: /* Mute */
		case 0xe9: /* Volume up */
		case 0xea: /* Volume down */
			return 0;
		default:
			/* Ignore dummy Consumer usages which make the
			 * keyboard incorrectly appear as a pointer device.
			 */
			return -1;
		}
	}

	return 0;
}

static int asus_start_multitouch(struct hid_device *hdev)
{
	int ret;
	const unsigned char buf[] = { FEATURE_REPORT_ID, 0x00, 0x03, 0x01, 0x00 };
	unsigned char *dmabuf = kmemdup(buf, sizeof(buf), GFP_KERNEL);

	if (!dmabuf) {
		ret = -ENOMEM;
		hid_err(hdev, "Asus failed to alloc dma buf: %d\n", ret);
		return ret;
	}

	ret = hid_hw_raw_request(hdev, dmabuf[0], dmabuf, sizeof(buf),
					HID_FEATURE_REPORT, HID_REQ_SET_REPORT);

	kfree(dmabuf);

	if (ret != sizeof(buf)) {
		hid_err(hdev, "Asus failed to start multitouch: %d\n", ret);
		return ret;
	}

	return 0;
}

static int __maybe_unused asus_reset_resume(struct hid_device *hdev)
{
	struct asus_drvdata *drvdata = hid_get_drvdata(hdev);

	if (drvdata->quirks & QUIRK_IS_MULTITOUCH)
		return asus_start_multitouch(hdev);

	return 0;
}

static int asus_probe(struct hid_device *hdev, const struct hid_device_id *id)
{
	int ret;
	struct asus_drvdata *drvdata;

	drvdata = devm_kzalloc(&hdev->dev, sizeof(*drvdata), GFP_KERNEL);
	if (drvdata == NULL) {
		hid_err(hdev, "Can't alloc Asus descriptor\n");
		return -ENOMEM;
	}

	hid_set_drvdata(hdev, drvdata);

	drvdata->quirks = id->driver_data;

	if (drvdata->quirks & QUIRK_NO_INIT_REPORTS)
		hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;

	ret = hid_parse(hdev);
	if (ret) {
		hid_err(hdev, "Asus hid parse failed: %d\n", ret);
		return ret;
	}

	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
	if (ret) {
		hid_err(hdev, "Asus hw start failed: %d\n", ret);
		return ret;
	}

	if (!drvdata->input) {
		hid_err(hdev, "Asus input not registered\n");
		ret = -ENOMEM;
		goto err_stop_hw;
	}

	if (drvdata->quirks & QUIRK_IS_MULTITOUCH) {
		drvdata->input->name = "Asus TouchPad";
	} else {
		drvdata->input->name = "Asus Keyboard";
	}

	if (drvdata->quirks & QUIRK_IS_MULTITOUCH) {
		ret = asus_start_multitouch(hdev);
		if (ret)
			goto err_stop_hw;
	}

	return 0;
err_stop_hw:
	hid_hw_stop(hdev);
	return ret;
}

static void asus_remove(struct hid_device *hdev)
{
	struct asus_drvdata *drvdata = hid_get_drvdata(hdev);

	if (drvdata->kbd_backlight) {
		drvdata->kbd_backlight->removed = true;
		cancel_work_sync(&drvdata->kbd_backlight->work);
	}
}

static __u8 *asus_report_fixup(struct hid_device *hdev, __u8 *rdesc,
		unsigned int *rsize)
{
	struct asus_drvdata *drvdata = hid_get_drvdata(hdev);

	if (drvdata->quirks & QUIRK_FIX_NOTEBOOK_REPORT &&
			*rsize >= 56 && rdesc[54] == 0x25 && rdesc[55] == 0x65) {
		hid_info(hdev, "Fixing up Asus notebook report descriptor\n");
		rdesc[55] = 0xdd;
	}
	return rdesc;
}

static const struct hid_device_id asus_devices[] = {
	{ HID_I2C_DEVICE(USB_VENDOR_ID_ASUSTEK,
		USB_DEVICE_ID_ASUSTEK_I2C_KEYBOARD), I2C_KEYBOARD_QUIRKS},
	{ HID_I2C_DEVICE(USB_VENDOR_ID_ASUSTEK,
		USB_DEVICE_ID_ASUSTEK_I2C_TOUCHPAD), I2C_TOUCHPAD_QUIRKS },
	{ HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK,
		USB_DEVICE_ID_ASUSTEK_ROG_KEYBOARD1) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK,
		USB_DEVICE_ID_ASUSTEK_ROG_KEYBOARD2), QUIRK_USE_KBD_BACKLIGHT },
	{ }
};
MODULE_DEVICE_TABLE(hid, asus_devices);

static struct hid_driver asus_driver = {
	.name			= "asus",
	.id_table		= asus_devices,
	.report_fixup		= asus_report_fixup,
	.probe                  = asus_probe,
	.remove			= asus_remove,
	.input_mapping          = asus_input_mapping,
	.input_configured       = asus_input_configured,
#ifdef CONFIG_PM
	.reset_resume           = asus_reset_resume,
#endif
	.raw_event		= asus_raw_event
};
module_hid_driver(asus_driver);

MODULE_LICENSE("GPL");
Commit	Line	Data
eeb01a57	1	/*
b94f7d5d	2	* HID driver for Asus notebook built-in keyboard.
eeb01a57 YF	3	* Fixes small logical maximum to match usage maximum.
eeb01a57 YF	4	*
b94f7d5d YF	5	* Currently supported devices are:
	6	* EeeBook X205TA
	7	* VivoBook E200HA
	8	*
eeb01a57 YF	9	* Copyright (c) 2016 Yusuke Fujimaki <usk.fujimaki@gmail.com>
	10	*
	11	* This module based on hid-ortek by
	12	* Copyright (c) 2010 Johnathon Harris <jmharris@gmail.com>
	13	* Copyright (c) 2011 Jiri Kosina
9ce12d8b BM	14	*
	15	* This module has been updated to add support for Asus i2c touchpad.
	16	*
	17	* Copyright (c) 2016 Brendan McGrath <redmcg@redmandi.dyndns.org>
	18	* Copyright (c) 2016 Victor Vlasenko <victor.vlasenko@sysgears.com>
	19	* Copyright (c) 2016 Frederik Wenigwieser <frederik.wenigwieser@gmail.com>
eeb01a57 YF	20	*/
	21
	22	/*
	23	* This program is free software; you can redistribute it and/or modify it
	24	* under the terms of the GNU General Public License as published by the Free
	25	* Software Foundation; either version 2 of the License, or (at your option)
	26	* any later version.
	27	*/
	28
eeb01a57 YF	29	#include <linux/hid.h>
eeb01a57 YF	30	#include <linux/module.h>
9ce12d8b	31	#include <linux/input/mt.h>
eeb01a57 YF	32
	33	#include "hid-ids.h"
	34
9ce12d8b BM	35	MODULE_AUTHOR("Yusuke Fujimaki <usk.fujimaki@gmail.com>");
	36	MODULE_AUTHOR("Brendan McGrath <redmcg@redmandi.dyndns.org>");
	37	MODULE_AUTHOR("Victor Vlasenko <victor.vlasenko@sysgears.com>");
	38	MODULE_AUTHOR("Frederik Wenigwieser <frederik.wenigwieser@gmail.com>");
	39	MODULE_DESCRIPTION("Asus HID Keyboard and TouchPad");
	40
	41	#define FEATURE_REPORT_ID 0x0d
	42	#define INPUT_REPORT_ID 0x5d
af22a610	43	#define FEATURE_KBD_REPORT_ID 0x5a
9ce12d8b BM	44
9ce12d8b BM	45	#define INPUT_REPORT_SIZE 28
af22a610 CC	46	#define FEATURE_KBD_REPORT_SIZE 16
	47
	48	#define SUPPORT_KBD_BACKLIGHT BIT(0)
9ce12d8b BM	49
	50	#define MAX_CONTACTS 5
	51
	52	#define MAX_X 2794
	53	#define MAX_Y 1758
	54	#define MAX_TOUCH_MAJOR 8
	55	#define MAX_PRESSURE 128
	56
	57	#define CONTACT_DATA_SIZE 5
	58
	59	#define BTN_LEFT_MASK 0x01
	60	#define CONTACT_TOOL_TYPE_MASK 0x80
	61	#define CONTACT_X_MSB_MASK 0xf0
	62	#define CONTACT_Y_MSB_MASK 0x0f
	63	#define CONTACT_TOUCH_MAJOR_MASK 0x07
	64	#define CONTACT_PRESSURE_MASK 0x7f
	65
	66	#define QUIRK_FIX_NOTEBOOK_REPORT BIT(0)
	67	#define QUIRK_NO_INIT_REPORTS BIT(1)
	68	#define QUIRK_SKIP_INPUT_MAPPING BIT(2)
	69	#define QUIRK_IS_MULTITOUCH BIT(3)
0485b1ec	70	#define QUIRK_NO_CONSUMER_USAGES BIT(4)
af22a610	71	#define QUIRK_USE_KBD_BACKLIGHT BIT(5)
9ce12d8b	72
a93913e1	73	#define I2C_KEYBOARD_QUIRKS (QUIRK_FIX_NOTEBOOK_REPORT \| \
0485b1ec MH	74	QUIRK_NO_INIT_REPORTS \| \
0485b1ec MH	75	QUIRK_NO_CONSUMER_USAGES)
a93913e1	76	#define I2C_TOUCHPAD_QUIRKS (QUIRK_NO_INIT_REPORTS \| \
9ce12d8b BM	77	QUIRK_SKIP_INPUT_MAPPING \| \
	78	QUIRK_IS_MULTITOUCH)
	79
	80	#define TRKID_SGN ((TRKID_MAX + 1) >> 1)
	81
af22a610 CC	82	struct asus_kbd_leds {
	83	struct led_classdev cdev;
	84	struct hid_device *hdev;
	85	struct work_struct work;
	86	unsigned int brightness;
	87	bool removed;
	88	};
	89
9ce12d8b BM	90	struct asus_drvdata {
	91	unsigned long quirks;
	92	struct input_dev *input;
af22a610 CC	93	struct asus_kbd_leds *kbd_backlight;
af22a610 CC	94	bool enable_backlight;
9ce12d8b BM	95	};
	96
	97	static void asus_report_contact_down(struct input_dev *input,
	98	int toolType, u8 *data)
	99	{
	100	int touch_major, pressure;
	101	int x = (data[0] & CONTACT_X_MSB_MASK) << 4 \| data[1];
	102	int y = MAX_Y - ((data[0] & CONTACT_Y_MSB_MASK) << 8 \| data[2]);
	103
	104	if (toolType == MT_TOOL_PALM) {
	105	touch_major = MAX_TOUCH_MAJOR;
	106	pressure = MAX_PRESSURE;
	107	} else {
	108	touch_major = (data[3] >> 4) & CONTACT_TOUCH_MAJOR_MASK;
	109	pressure = data[4] & CONTACT_PRESSURE_MASK;
	110	}
	111
	112	input_report_abs(input, ABS_MT_POSITION_X, x);
	113	input_report_abs(input, ABS_MT_POSITION_Y, y);
	114	input_report_abs(input, ABS_MT_TOUCH_MAJOR, touch_major);
	115	input_report_abs(input, ABS_MT_PRESSURE, pressure);
	116	}
	117
	118	/* Required for Synaptics Palm Detection */
	119	static void asus_report_tool_width(struct input_dev *input)
	120	{
	121	struct input_mt *mt = input->mt;
	122	struct input_mt_slot *oldest;
	123	int oldid, count, i;
	124
	125	oldest = NULL;
	126	oldid = mt->trkid;
	127	count = 0;
	128
	129	for (i = 0; i < mt->num_slots; ++i) {
	130	struct input_mt_slot *ps = &mt->slots[i];
	131	int id = input_mt_get_value(ps, ABS_MT_TRACKING_ID);
	132
	133	if (id < 0)
	134	continue;
	135	if ((id - oldid) & TRKID_SGN) {
	136	oldest = ps;
	137	oldid = id;
	138	}
	139	count++;
	140	}
	141
	142	if (oldest) {
	143	input_report_abs(input, ABS_TOOL_WIDTH,
	144	input_mt_get_value(oldest, ABS_MT_TOUCH_MAJOR));
	145	}
	146	}
	147
	148	static void asus_report_input(struct input_dev input, u8 data)
	149	{
	150	int i;
	151	u8 *contactData = data + 2;
	152
	153	for (i = 0; i < MAX_CONTACTS; i++) {
	154	bool down = !!(data[1] & BIT(i+3));
	155	int toolType = contactData[3] & CONTACT_TOOL_TYPE_MASK ?
	156	MT_TOOL_PALM : MT_TOOL_FINGER;
	157
	158	input_mt_slot(input, i);
159	input_mt_report_slot_state(input, toolType, down);
160
161	if (down) {
162	asus_report_contact_down(input, toolType, contactData);
163	contactData += CONTACT_DATA_SIZE;
164	}
165	}
166
167	input_report_key(input, BTN_LEFT, data[1] & BTN_LEFT_MASK);
168	asus_report_tool_width(input);
169
170	input_mt_sync_frame(input);
171	input_sync(input);
172	}
173
174	static int asus_raw_event(struct hid_device *hdev,
175	struct hid_report report, u8 data, int size)
176	{
177	struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
178
179	if (drvdata->quirks & QUIRK_IS_MULTITOUCH &&
180	data[0] == INPUT_REPORT_ID &&
181	size == INPUT_REPORT_SIZE) {
182	asus_report_input(drvdata->input, data);
183	return 1;
184	}
185
186	return 0;
187	}
188
af22a610 CC	189	static int asus_kbd_set_report(struct hid_device hdev, u8 buf, size_t buf_size)
	190	{
	191	unsigned char *dmabuf;
	192	int ret;
	193
	194	dmabuf = kmemdup(buf, buf_size, GFP_KERNEL);
	195	if (!dmabuf)
	196	return -ENOMEM;
	197
	198	ret = hid_hw_raw_request(hdev, FEATURE_KBD_REPORT_ID, dmabuf,
	199	buf_size, HID_FEATURE_REPORT,
	200	HID_REQ_SET_REPORT);
	201	kfree(dmabuf);
	202
	203	return ret;
	204	}
	205
	206	static int asus_kbd_init(struct hid_device *hdev)
	207	{
	208	u8 buf[] = { FEATURE_KBD_REPORT_ID, 0x41, 0x53, 0x55, 0x53, 0x20, 0x54,
	209	0x65, 0x63, 0x68, 0x2e, 0x49, 0x6e, 0x63, 0x2e, 0x00 };
	210	int ret;
	211
	212	ret = asus_kbd_set_report(hdev, buf, sizeof(buf));
	213	if (ret < 0)
	214	hid_err(hdev, "Asus failed to send init command: %d\n", ret);
	215
	216	return ret;
	217	}
	218
	219	static int asus_kbd_get_functions(struct hid_device *hdev,
	220	unsigned char *kbd_func)
	221	{
	222	u8 buf[] = { FEATURE_KBD_REPORT_ID, 0x05, 0x20, 0x31, 0x00, 0x08 };
	223	u8 *readbuf;
	224	int ret;
	225
	226	ret = asus_kbd_set_report(hdev, buf, sizeof(buf));
	227	if (ret < 0) {
	228	hid_err(hdev, "Asus failed to send configuration command: %d\n", ret);
	229	return ret;
	230	}
	231
	232	readbuf = kzalloc(FEATURE_KBD_REPORT_SIZE, GFP_KERNEL);
	233	if (!readbuf)
	234	return -ENOMEM;
	235
	236	ret = hid_hw_raw_request(hdev, FEATURE_KBD_REPORT_ID, readbuf,
	237	FEATURE_KBD_REPORT_SIZE, HID_FEATURE_REPORT,
	238	HID_REQ_GET_REPORT);
	239	if (ret < 0) {
	240	hid_err(hdev, "Asus failed to request functions: %d\n", ret);
	241	kfree(readbuf);
	242	return ret;
	243	}
	244
	245	*kbd_func = readbuf[6];
	246
	247	kfree(readbuf);
	248	return ret;
	249	}
	250
	251	static void asus_kbd_backlight_set(struct led_classdev *led_cdev,
	252	enum led_brightness brightness)
253	{
254	struct asus_kbd_leds *led = container_of(led_cdev, struct asus_kbd_leds,
255	cdev);
256	if (led->brightness == brightness)
257	return;
258
259	led->brightness = brightness;
260	schedule_work(&led->work);
261	}
262
263	static enum led_brightness asus_kbd_backlight_get(struct led_classdev *led_cdev)
264	{
265	struct asus_kbd_leds *led = container_of(led_cdev, struct asus_kbd_leds,
266	cdev);
267
268	return led->brightness;
269	}
270
271	static void asus_kbd_backlight_work(struct work_struct *work)
272	{
273	struct asus_kbd_leds *led = container_of(work, struct asus_kbd_leds, work);
274	u8 buf[] = { FEATURE_KBD_REPORT_ID, 0xba, 0xc5, 0xc4, 0x00 };
275	int ret;
276
277	if (led->removed)
278	return;
279
280	buf[4] = led->brightness;
281
282	ret = asus_kbd_set_report(led->hdev, buf, sizeof(buf));
283	if (ret < 0)
284	hid_err(led->hdev, "Asus failed to set keyboard backlight: %d\n", ret);
285	}
286
287	static int asus_kbd_register_leds(struct hid_device *hdev)
288	{
289	struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
290	unsigned char kbd_func;
291	int ret;
292
293	/* Initialize keyboard */
294	ret = asus_kbd_init(hdev);
295	if (ret < 0)
296	return ret;
297
298	/* Get keyboard functions */
299	ret = asus_kbd_get_functions(hdev, &kbd_func);
300	if (ret < 0)
301	return ret;
302
303	/* Check for backlight support */
304	if (!(kbd_func & SUPPORT_KBD_BACKLIGHT))
305	return -ENODEV;
306
307	drvdata->kbd_backlight = devm_kzalloc(&hdev->dev,
308	sizeof(struct asus_kbd_leds),
309	GFP_KERNEL);
310	if (!drvdata->kbd_backlight)
311	return -ENOMEM;
312
313	drvdata->kbd_backlight->removed = false;
314	drvdata->kbd_backlight->brightness = 0;
315	drvdata->kbd_backlight->hdev = hdev;
316	drvdata->kbd_backlight->cdev.name = "asus::kbd_backlight";
317	drvdata->kbd_backlight->cdev.max_brightness = 3;
318	drvdata->kbd_backlight->cdev.brightness_set = asus_kbd_backlight_set;
319	drvdata->kbd_backlight->cdev.brightness_get = asus_kbd_backlight_get;
320	INIT_WORK(&drvdata->kbd_backlight->work, asus_kbd_backlight_work);
321
322	ret = devm_led_classdev_register(&hdev->dev, &drvdata->kbd_backlight->cdev);
323	if (ret < 0) {
324	/* No need to have this still around */
325	devm_kfree(&hdev->dev, drvdata->kbd_backlight);
326	}
327
328	return ret;
329	}
330
9ce12d8b BM	331	static int asus_input_configured(struct hid_device hdev, struct hid_input hi)
9ce12d8b BM	332	{
c8b1b3dd	333	struct input_dev *input = hi->input;
9ce12d8b BM	334	struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
	335
	336	if (drvdata->quirks & QUIRK_IS_MULTITOUCH) {
	337	int ret;
9ce12d8b BM	338
	339	input_set_abs_params(input, ABS_MT_POSITION_X, 0, MAX_X, 0, 0);
	340	input_set_abs_params(input, ABS_MT_POSITION_Y, 0, MAX_Y, 0, 0);
	341	input_set_abs_params(input, ABS_TOOL_WIDTH, 0, MAX_TOUCH_MAJOR, 0, 0);
	342	input_set_abs_params(input, ABS_MT_TOUCH_MAJOR, 0, MAX_TOUCH_MAJOR, 0, 0);
	343	input_set_abs_params(input, ABS_MT_PRESSURE, 0, MAX_PRESSURE, 0, 0);
	344
	345	__set_bit(BTN_LEFT, input->keybit);
	346	__set_bit(INPUT_PROP_BUTTONPAD, input->propbit);
	347
	348	ret = input_mt_init_slots(input, MAX_CONTACTS, INPUT_MT_POINTER);
	349
	350	if (ret) {
	351	hid_err(hdev, "Asus input mt init slots failed: %d\n", ret);
	352	return ret;
	353	}
9ce12d8b BM	354	}
9ce12d8b BM	355
c8b1b3dd BM	356	drvdata->input = input;
c8b1b3dd BM	357
af22a610 CC	358	if (drvdata->enable_backlight && asus_kbd_register_leds(hdev))
	359	hid_warn(hdev, "Failed to initialize backlight.\n");
	360
9ce12d8b BM	361	return 0;
	362	}
	363
a93913e1	364	#define asus_map_key_clear(c) hid_map_usage_clear(hi, usage, bit, \
1caccc25	365	max, EV_KEY, (c))
9ce12d8b BM	366	static int asus_input_mapping(struct hid_device *hdev,
	367	struct hid_input hi, struct hid_field field,
	368	struct hid_usage usage, unsigned long *bit,
	369	int *max)
	370	{
	371	struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
	372
	373	if (drvdata->quirks & QUIRK_SKIP_INPUT_MAPPING) {
	374	/* Don't map anything from the HID report.
	375	* We do it all manually in asus_input_configured
	376	*/
	377	return -1;
	378	}
	379
a93913e1	380	/* ASUS-specific keyboard hotkeys */
1caccc25 CC	381	if ((usage->hid & HID_USAGE_PAGE) == 0xff310000) {
	382	set_bit(EV_REP, hi->input->evbit);
	383	switch (usage->hid & HID_USAGE) {
a93913e1 MH	384	case 0x10: asus_map_key_clear(KEY_BRIGHTNESSDOWN); break;
	385	case 0x20: asus_map_key_clear(KEY_BRIGHTNESSUP); break;
	386	case 0x35: asus_map_key_clear(KEY_DISPLAY_OFF); break;
	387	case 0x6c: asus_map_key_clear(KEY_SLEEP); break;
	388	case 0x82: asus_map_key_clear(KEY_CAMERA); break;
802b24b4	389	case 0x88: asus_map_key_clear(KEY_RFKILL); break;
a93913e1 MH	390	case 0xb5: asus_map_key_clear(KEY_CALC); break;
	391	case 0xc4: asus_map_key_clear(KEY_KBDILLUMUP); break;
	392	case 0xc5: asus_map_key_clear(KEY_KBDILLUMDOWN); break;
1caccc25 CC	393
1caccc25 CC	394	/* ASUS touchpad toggle */
a93913e1	395	case 0x6b: asus_map_key_clear(KEY_F21); break;
1caccc25 CC	396
1caccc25 CC	397	/* ROG key */
a93913e1	398	case 0x38: asus_map_key_clear(KEY_PROG1); break;
1caccc25 CC	399
1caccc25 CC	400	/* Fn+C ASUS Splendid */
a93913e1	401	case 0xba: asus_map_key_clear(KEY_PROG2); break;
1caccc25 CC	402
1caccc25 CC	403	/* Fn+Space Power4Gear Hybrid */
a93913e1	404	case 0x5c: asus_map_key_clear(KEY_PROG3); break;
1caccc25 CC	405
1caccc25 CC	406	default:
0485b1ec MH	407	/* ASUS lazily declares 256 usages, ignore the rest,
	408	* as some make the keyboard appear as a pointer device. */
	409	return -1;
1caccc25	410	}
af22a610 CC	411
	412	/*
	413	* Check and enable backlight only on devices with UsagePage ==
	414	* 0xff31 to avoid initializing the keyboard firmware multiple
	415	* times on devices with multiple HID descriptors but same
	416	* PID/VID.
	417	*/
	418	if (drvdata->quirks & QUIRK_USE_KBD_BACKLIGHT)
	419	drvdata->enable_backlight = true;
	420
1caccc25 CC	421	return 1;
	422	}
	423
0485b1ec MH	424	if (drvdata->quirks & QUIRK_NO_CONSUMER_USAGES &&
	425	(usage->hid & HID_USAGE_PAGE) == HID_UP_CONSUMER) {
	426	switch (usage->hid & HID_USAGE) {
	427	case 0xe2: /* Mute */
	428	case 0xe9: /* Volume up */
	429	case 0xea: /* Volume down */
	430	return 0;
	431	default:
	432	/* Ignore dummy Consumer usages which make the
	433	* keyboard incorrectly appear as a pointer device.
	434	*/
	435	return -1;
	436	}
	437	}
	438
9ce12d8b BM	439	return 0;
	440	}
	441
	442	static int asus_start_multitouch(struct hid_device *hdev)
	443	{
	444	int ret;
	445	const unsigned char buf[] = { FEATURE_REPORT_ID, 0x00, 0x03, 0x01, 0x00 };
	446	unsigned char *dmabuf = kmemdup(buf, sizeof(buf), GFP_KERNEL);
	447
	448	if (!dmabuf) {
	449	ret = -ENOMEM;
	450	hid_err(hdev, "Asus failed to alloc dma buf: %d\n", ret);
	451	return ret;
	452	}
	453
	454	ret = hid_hw_raw_request(hdev, dmabuf[0], dmabuf, sizeof(buf),
	455	HID_FEATURE_REPORT, HID_REQ_SET_REPORT);
	456
	457	kfree(dmabuf);
	458
	459	if (ret != sizeof(buf)) {
	460	hid_err(hdev, "Asus failed to start multitouch: %d\n", ret);
	461	return ret;
	462	}
	463
	464	return 0;
	465	}
	466
	467	static int __maybe_unused asus_reset_resume(struct hid_device *hdev)
	468	{
	469	struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
	470
	471	if (drvdata->quirks & QUIRK_IS_MULTITOUCH)
	472	return asus_start_multitouch(hdev);
	473
	474	return 0;
	475	}
	476
	477	static int asus_probe(struct hid_device hdev, const struct hid_device_id id)
	478	{
	479	int ret;
	480	struct asus_drvdata *drvdata;
	481
	482	drvdata = devm_kzalloc(&hdev->dev, sizeof(*drvdata), GFP_KERNEL);
	483	if (drvdata == NULL) {
	484	hid_err(hdev, "Can't alloc Asus descriptor\n");
	485	return -ENOMEM;
	486	}
	487
	488	hid_set_drvdata(hdev, drvdata);
	489
	490	drvdata->quirks = id->driver_data;
	491
	492	if (drvdata->quirks & QUIRK_NO_INIT_REPORTS)
	493	hdev->quirks \|= HID_QUIRK_NO_INIT_REPORTS;
	494
	495	ret = hid_parse(hdev);
	496	if (ret) {
	497	hid_err(hdev, "Asus hid parse failed: %d\n", ret);
	498	return ret;
	499	}
	500
	501	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
	502	if (ret) {
503	hid_err(hdev, "Asus hw start failed: %d\n", ret);
504	return ret;
505	}
506
507	if (!drvdata->input) {
508	hid_err(hdev, "Asus input not registered\n");
509	ret = -ENOMEM;
510	goto err_stop_hw;
511	}
512
c8b1b3dd BM	513	if (drvdata->quirks & QUIRK_IS_MULTITOUCH) {
	514	drvdata->input->name = "Asus TouchPad";
	515	} else {
	516	drvdata->input->name = "Asus Keyboard";
	517	}
9ce12d8b BM	518
	519	if (drvdata->quirks & QUIRK_IS_MULTITOUCH) {
	520	ret = asus_start_multitouch(hdev);
	521	if (ret)
	522	goto err_stop_hw;
	523	}
	524
	525	return 0;
	526	err_stop_hw:
	527	hid_hw_stop(hdev);
	528	return ret;
	529	}
	530
af22a610 CC	531	static void asus_remove(struct hid_device *hdev)
	532	{
	533	struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
	534
	535	if (drvdata->kbd_backlight) {
	536	drvdata->kbd_backlight->removed = true;
	537	cancel_work_sync(&drvdata->kbd_backlight->work);
	538	}
	539	}
	540
eeb01a57 YF	541	static __u8 asus_report_fixup(struct hid_device hdev, __u8 *rdesc,
	542	unsigned int *rsize)
	543	{
9ce12d8b BM	544	struct asus_drvdata *drvdata = hid_get_drvdata(hdev);
	545
	546	if (drvdata->quirks & QUIRK_FIX_NOTEBOOK_REPORT &&
	547	*rsize >= 56 && rdesc[54] == 0x25 && rdesc[55] == 0x65) {
b94f7d5d	548	hid_info(hdev, "Fixing up Asus notebook report descriptor\n");
eeb01a57 YF	549	rdesc[55] = 0xdd;
	550	}
	551	return rdesc;
	552	}
	553
	554	static const struct hid_device_id asus_devices[] = {
9ce12d8b	555	{ HID_I2C_DEVICE(USB_VENDOR_ID_ASUSTEK,
a93913e1	556	USB_DEVICE_ID_ASUSTEK_I2C_KEYBOARD), I2C_KEYBOARD_QUIRKS},
9ce12d8b	557	{ HID_I2C_DEVICE(USB_VENDOR_ID_ASUSTEK,
a93913e1	558	USB_DEVICE_ID_ASUSTEK_I2C_TOUCHPAD), I2C_TOUCHPAD_QUIRKS },
1caccc25 CC	559	{ HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK,
	560	USB_DEVICE_ID_ASUSTEK_ROG_KEYBOARD1) },
	561	{ HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK,
af22a610	562	USB_DEVICE_ID_ASUSTEK_ROG_KEYBOARD2), QUIRK_USE_KBD_BACKLIGHT },
eeb01a57 YF	563	{ }
	564	};
	565	MODULE_DEVICE_TABLE(hid, asus_devices);
	566
	567	static struct hid_driver asus_driver = {
9ce12d8b BM	568	.name = "asus",
	569	.id_table = asus_devices,
	570	.report_fixup = asus_report_fixup,
	571	.probe = asus_probe,
af22a610	572	.remove = asus_remove,
9ce12d8b BM	573	.input_mapping = asus_input_mapping,
	574	.input_configured = asus_input_configured,
	575	#ifdef CONFIG_PM
	576	.reset_resume = asus_reset_resume,
	577	#endif
	578	.raw_event = asus_raw_event
eeb01a57 YF	579	};
	580	module_hid_driver(asus_driver);
	581
	582	MODULE_LICENSE("GPL");