[linux.git] / drivers / hid / hid-uclogic-core.c

// SPDX-License-Identifier: GPL-2.0+
/*
 *  HID driver for UC-Logic devices not fully compliant with HID standard
 *
 *  Copyright (c) 2010-2014 Nikolai Kondrashov
 *  Copyright (c) 2013 Martin Rusko
 */

/*
 * 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/device.h>
#include <linux/hid.h>
#include <linux/module.h>
#include <linux/timer.h>
#include "usbhid/usbhid.h"
#include "hid-uclogic-params.h"

#include "hid-ids.h"

/* Driver data */
struct uclogic_drvdata {
	/* Interface parameters */
	struct uclogic_params params;
	/* Pointer to the replacement report descriptor. NULL if none. */
	__u8 *desc_ptr;
	/*
	 * Size of the replacement report descriptor.
	 * Only valid if desc_ptr is not NULL
	 */
	unsigned int desc_size;
	/* Pen input device */
	struct input_dev *pen_input;
	/* In-range timer */
	struct timer_list inrange_timer;
	/* Last rotary encoder state, or U8_MAX for none */
	u8 re_state;
};

/**
 * uclogic_inrange_timeout - handle pen in-range state timeout.
 * Emulate input events normally generated when pen goes out of range for
 * tablets which don't report that.
 *
 * @t:	The timer the timeout handler is attached to, stored in a struct
 *	uclogic_drvdata.
 */
static void uclogic_inrange_timeout(struct timer_list *t)
{
	struct uclogic_drvdata *drvdata = from_timer(drvdata, t,
							inrange_timer);
	struct input_dev *input = drvdata->pen_input;

	if (input == NULL)
		return;
	input_report_abs(input, ABS_PRESSURE, 0);
	/* If BTN_TOUCH state is changing */
	if (test_bit(BTN_TOUCH, input->key)) {
		input_event(input, EV_MSC, MSC_SCAN,
				/* Digitizer Tip Switch usage */
				0xd0042);
		input_report_key(input, BTN_TOUCH, 0);
	}
	input_report_key(input, BTN_TOOL_PEN, 0);
	input_sync(input);
}

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

	if (drvdata->desc_ptr != NULL) {
		rdesc = drvdata->desc_ptr;
		*rsize = drvdata->desc_size;
	}
	return rdesc;
}

static int uclogic_input_mapping(struct hid_device *hdev,
				 struct hid_input *hi,
				 struct hid_field *field,
				 struct hid_usage *usage,
				 unsigned long **bit,
				 int *max)
{
	struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev);
	struct uclogic_params *params = &drvdata->params;

	/* discard the unused pen interface */
	if (params->pen_unused && (field->application == HID_DG_PEN))
		return -1;

	/* let hid-core decide what to do */
	return 0;
}

static int uclogic_input_configured(struct hid_device *hdev,
		struct hid_input *hi)
{
	struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev);
	struct uclogic_params *params = &drvdata->params;
	char *name;
	const char *suffix = NULL;
	struct hid_field *field;
	size_t len;

	/* no report associated (HID_QUIRK_MULTI_INPUT not set) */
	if (!hi->report)
		return 0;

	/*
	 * If this is the input corresponding to the pen report
	 * in need of tweaking.
	 */
	if (hi->report->id == params->pen.id) {
		/* Remember the input device so we can simulate events */
		drvdata->pen_input = hi->input;
	}

	field = hi->report->field[0];

	switch (field->application) {
	case HID_GD_KEYBOARD:
		suffix = "Keyboard";
		break;
	case HID_GD_MOUSE:
		suffix = "Mouse";
		break;
	case HID_GD_KEYPAD:
		suffix = "Pad";
		break;
	case HID_DG_PEN:
		suffix = "Pen";
		break;
	case HID_CP_CONSUMER_CONTROL:
		suffix = "Consumer Control";
		break;
	case HID_GD_SYSTEM_CONTROL:
		suffix = "System Control";
		break;
	}

	if (suffix) {
		len = strlen(hdev->name) + 2 + strlen(suffix);
		name = devm_kzalloc(&hi->input->dev, len, GFP_KERNEL);
		if (name) {
			snprintf(name, len, "%s %s", hdev->name, suffix);
			hi->input->name = name;
		}
	}

	return 0;
}

static int uclogic_probe(struct hid_device *hdev,
		const struct hid_device_id *id)
{
	int rc;
	struct uclogic_drvdata *drvdata = NULL;
	bool params_initialized = false;

	/*
	 * libinput requires the pad interface to be on a different node
	 * than the pen, so use QUIRK_MULTI_INPUT for all tablets.
	 */
	hdev->quirks |= HID_QUIRK_MULTI_INPUT;

	/* Allocate and assign driver data */
	drvdata = devm_kzalloc(&hdev->dev, sizeof(*drvdata), GFP_KERNEL);
	if (drvdata == NULL) {
		rc = -ENOMEM;
		goto failure;
	}
	timer_setup(&drvdata->inrange_timer, uclogic_inrange_timeout, 0);
	drvdata->re_state = U8_MAX;
	hid_set_drvdata(hdev, drvdata);

	/* Initialize the device and retrieve interface parameters */
	rc = uclogic_params_init(&drvdata->params, hdev);
	if (rc != 0) {
		hid_err(hdev, "failed probing parameters: %d\n", rc);
		goto failure;
	}
	params_initialized = true;
	hid_dbg(hdev, "parameters:\n" UCLOGIC_PARAMS_FMT_STR,
		UCLOGIC_PARAMS_FMT_ARGS(&drvdata->params));
	if (drvdata->params.invalid) {
		hid_info(hdev, "interface is invalid, ignoring\n");
		rc = -ENODEV;
		goto failure;
	}

	/* Generate replacement report descriptor */
	rc = uclogic_params_get_desc(&drvdata->params,
				     &drvdata->desc_ptr,
				     &drvdata->desc_size);
	if (rc) {
		hid_err(hdev,
			"failed generating replacement report descriptor: %d\n",
			rc);
		goto failure;
	}

	rc = hid_parse(hdev);
	if (rc) {
		hid_err(hdev, "parse failed\n");
		goto failure;
	}

	rc = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
	if (rc) {
		hid_err(hdev, "hw start failed\n");
		goto failure;
	}

	return 0;
failure:
	/* Assume "remove" might not be called if "probe" failed */
	if (params_initialized)
		uclogic_params_cleanup(&drvdata->params);
	return rc;
}

#ifdef CONFIG_PM
static int uclogic_resume(struct hid_device *hdev)
{
	int rc;
	struct uclogic_params params;

	/* Re-initialize the device, but discard parameters */
	rc = uclogic_params_init(&params, hdev);
	if (rc != 0)
		hid_err(hdev, "failed to re-initialize the device\n");
	else
		uclogic_params_cleanup(&params);

	return rc;
}
#endif

static int uclogic_raw_event(struct hid_device *hdev,
				struct hid_report *report,
				u8 *data, int size)
{
	struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev);
	struct uclogic_params *params = &drvdata->params;

	/* Tweak pen reports, if necessary */
	if (!params->pen_unused &&
	    (report->type == HID_INPUT_REPORT) &&
	    (report->id == params->pen.id) &&
	    (size >= 2)) {
		/* If it's the "virtual" frame controls report */
		if (params->frame.id != 0 &&
		    data[1] & params->pen_frame_flag) {
			/* Change to virtual frame controls report ID */
			data[0] = params->frame.id;
			return 0;
		}
		/* If in-range reports are inverted */
		if (params->pen.inrange ==
			UCLOGIC_PARAMS_PEN_INRANGE_INVERTED) {
			/* Invert the in-range bit */
			data[1] ^= 0x40;
		}
		/*
		 * If report contains fragmented high-resolution pen
		 * coordinates
		 */
		if (size >= 10 && params->pen.fragmented_hires) {
			u8 pressure_low_byte;
			u8 pressure_high_byte;

			/* Lift pressure bytes */
			pressure_low_byte = data[6];
			pressure_high_byte = data[7];
			/*
			 * Move Y coord to make space for high-order X
			 * coord byte
			 */
			data[6] = data[5];
			data[5] = data[4];
			/* Move high-order X coord byte */
			data[4] = data[8];
			/* Move high-order Y coord byte */
			data[7] = data[9];
			/* Place pressure bytes */
			data[8] = pressure_low_byte;
			data[9] = pressure_high_byte;
		}
		/* If we need to emulate in-range detection */
		if (params->pen.inrange == UCLOGIC_PARAMS_PEN_INRANGE_NONE) {
			/* Set in-range bit */
			data[1] |= 0x40;
			/* (Re-)start in-range timeout */
			mod_timer(&drvdata->inrange_timer,
					jiffies + msecs_to_jiffies(100));
		}
	}

	/* Tweak frame control reports, if necessary */
	if ((report->type == HID_INPUT_REPORT) &&
	    (report->id == params->frame.id)) {
		/* If need to, and can, set pad device ID for Wacom drivers */
		if (params->frame.dev_id_byte > 0 &&
		    params->frame.dev_id_byte < size) {
			data[params->frame.dev_id_byte] = 0xf;
		}
		/* If need to, and can, read rotary encoder state change */
		if (params->frame.re_lsb > 0 &&
		    params->frame.re_lsb / 8 < size) {
			unsigned int byte = params->frame.re_lsb / 8;
			unsigned int bit = params->frame.re_lsb % 8;

			u8 change;
			u8 prev_state = drvdata->re_state;
			/* Read Gray-coded state */
			u8 state = (data[byte] >> bit) & 0x3;
			/* Encode state change into 2-bit signed integer */
			if ((prev_state == 1 && state == 0) ||
			    (prev_state == 2 && state == 3)) {
				change = 1;
			} else if ((prev_state == 2 && state == 0) ||
				   (prev_state == 1 && state == 3)) {
				change = 3;
			} else {
				change = 0;
			}
			/* Write change */
			data[byte] = (data[byte] & ~((u8)3 << bit)) |
					(change << bit);
			/* Remember state */
			drvdata->re_state = state;
		}
	}

	return 0;
}

static void uclogic_remove(struct hid_device *hdev)
{
	struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev);

	del_timer_sync(&drvdata->inrange_timer);
	hid_hw_stop(hdev);
	kfree(drvdata->desc_ptr);
	uclogic_params_cleanup(&drvdata->params);
}

static const struct hid_device_id uclogic_devices[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
				USB_DEVICE_ID_UCLOGIC_TABLET_PF1209) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
				USB_DEVICE_ID_UCLOGIC_TABLET_WP4030U) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
				USB_DEVICE_ID_UCLOGIC_TABLET_WP5540U) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
				USB_DEVICE_ID_UCLOGIC_TABLET_WP8060U) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
				USB_DEVICE_ID_UCLOGIC_TABLET_WP1062) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
				USB_DEVICE_ID_UCLOGIC_WIRELESS_TABLET_TWHL850) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
				USB_DEVICE_ID_UCLOGIC_TABLET_TWHA60) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_HUION,
				USB_DEVICE_ID_HUION_TABLET) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
				USB_DEVICE_ID_HUION_TABLET) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
				USB_DEVICE_ID_YIYNOVA_TABLET) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
				USB_DEVICE_ID_UCLOGIC_UGEE_TABLET_81) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
				USB_DEVICE_ID_UCLOGIC_UGEE_TABLET_45) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
				USB_DEVICE_ID_UCLOGIC_UGEE_TABLET_47) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
				USB_DEVICE_ID_UCLOGIC_DRAWIMAGE_G3) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UGTIZER,
				USB_DEVICE_ID_UGTIZER_TABLET_GP0610) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
				USB_DEVICE_ID_UGEE_TABLET_G5) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
				USB_DEVICE_ID_UGEE_TABLET_EX07S) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
				USB_DEVICE_ID_UGEE_XPPEN_TABLET_G540) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
				USB_DEVICE_ID_UGEE_XPPEN_TABLET_G640) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
				USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO01) },
	{ }
};
MODULE_DEVICE_TABLE(hid, uclogic_devices);

static struct hid_driver uclogic_driver = {
	.name = "uclogic",
	.id_table = uclogic_devices,
	.probe = uclogic_probe,
	.remove = uclogic_remove,
	.report_fixup = uclogic_report_fixup,
	.raw_event = uclogic_raw_event,
	.input_mapping = uclogic_input_mapping,
	.input_configured = uclogic_input_configured,
#ifdef CONFIG_PM
	.resume	          = uclogic_resume,
	.reset_resume     = uclogic_resume,
#endif
};
module_hid_driver(uclogic_driver);

MODULE_AUTHOR("Martin Rusko");
MODULE_AUTHOR("Nikolai Kondrashov");
MODULE_LICENSE("GPL");
Commit	Line	Data
ff0c13d6 NK	1	// SPDX-License-Identifier: GPL-2.0+
	2	/*
	3	* HID driver for UC-Logic devices not fully compliant with HID standard
	4	*
	5	* Copyright (c) 2010-2014 Nikolai Kondrashov
	6	* Copyright (c) 2013 Martin Rusko
	7	*/
	8
	9	/*
	10	* This program is free software; you can redistribute it and/or modify it
	11	* under the terms of the GNU General Public License as published by the Free
	12	* Software Foundation; either version 2 of the License, or (at your option)
	13	* any later version.
	14	*/
	15
	16	#include <linux/device.h>
	17	#include <linux/hid.h>
	18	#include <linux/module.h>
01309e29	19	#include <linux/timer.h>
ff0c13d6	20	#include "usbhid/usbhid.h"
9614219e	21	#include "hid-uclogic-params.h"
ff0c13d6 NK	22
	23	#include "hid-ids.h"
	24
ff0c13d6 NK	25	/* Driver data */
ff0c13d6 NK	26	struct uclogic_drvdata {
9614219e NK	27	/* Interface parameters */
	28	struct uclogic_params params;
	29	/* Pointer to the replacement report descriptor. NULL if none. */
	30	__u8 *desc_ptr;
	31	/*
	32	* Size of the replacement report descriptor.
	33	* Only valid if desc_ptr is not NULL
	34	*/
	35	unsigned int desc_size;
01309e29 NK	36	/* Pen input device */
	37	struct input_dev *pen_input;
	38	/* In-range timer */
	39	struct timer_list inrange_timer;
8a47670c NK	40	/* Last rotary encoder state, or U8_MAX for none */
8a47670c NK	41	u8 re_state;
ff0c13d6 NK	42	};
ff0c13d6 NK	43
01309e29 NK	44	/**
	45	* uclogic_inrange_timeout - handle pen in-range state timeout.
	46	* Emulate input events normally generated when pen goes out of range for
	47	* tablets which don't report that.
	48	*
	49	* @t: The timer the timeout handler is attached to, stored in a struct
	50	* uclogic_drvdata.
	51	*/
	52	static void uclogic_inrange_timeout(struct timer_list *t)
	53	{
	54	struct uclogic_drvdata *drvdata = from_timer(drvdata, t,
	55	inrange_timer);
	56	struct input_dev *input = drvdata->pen_input;
	57
	58	if (input == NULL)
	59	return;
	60	input_report_abs(input, ABS_PRESSURE, 0);
	61	/* If BTN_TOUCH state is changing */
	62	if (test_bit(BTN_TOUCH, input->key)) {
	63	input_event(input, EV_MSC, MSC_SCAN,
	64	/* Digitizer Tip Switch usage */
	65	0xd0042);
	66	input_report_key(input, BTN_TOUCH, 0);
	67	}
	68	input_report_key(input, BTN_TOOL_PEN, 0);
	69	input_sync(input);
	70	}
	71
ff0c13d6 NK	72	static __u8 uclogic_report_fixup(struct hid_device hdev, __u8 *rdesc,
	73	unsigned int *rsize)
	74	{
ff0c13d6 NK	75	struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev);
ff0c13d6 NK	76
9614219e NK	77	if (drvdata->desc_ptr != NULL) {
	78	rdesc = drvdata->desc_ptr;
	79	*rsize = drvdata->desc_size;
ff0c13d6	80	}
ff0c13d6 NK	81	return rdesc;
	82	}
	83
9614219e NK	84	static int uclogic_input_mapping(struct hid_device *hdev,
	85	struct hid_input *hi,
	86	struct hid_field *field,
	87	struct hid_usage *usage,
	88	unsigned long **bit,
	89	int *max)
ff0c13d6 NK	90	{
ff0c13d6 NK	91	struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev);
9614219e	92	struct uclogic_params *params = &drvdata->params;
ff0c13d6 NK	93
ff0c13d6 NK	94	/* discard the unused pen interface */
9614219e	95	if (params->pen_unused && (field->application == HID_DG_PEN))
ff0c13d6 NK	96	return -1;
	97
	98	/* let hid-core decide what to do */
	99	return 0;
	100	}
	101
	102	static int uclogic_input_configured(struct hid_device *hdev,
	103	struct hid_input *hi)
	104	{
01309e29 NK	105	struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev);
01309e29 NK	106	struct uclogic_params *params = &drvdata->params;
ff0c13d6 NK	107	char *name;
	108	const char *suffix = NULL;
	109	struct hid_field *field;
	110	size_t len;
	111
	112	/* no report associated (HID_QUIRK_MULTI_INPUT not set) */
	113	if (!hi->report)
	114	return 0;
	115
01309e29 NK	116	/*
	117	* If this is the input corresponding to the pen report
	118	* in need of tweaking.
	119	*/
	120	if (hi->report->id == params->pen.id) {
	121	/* Remember the input device so we can simulate events */
	122	drvdata->pen_input = hi->input;
	123	}
	124
ff0c13d6 NK	125	field = hi->report->field[0];
	126
	127	switch (field->application) {
	128	case HID_GD_KEYBOARD:
	129	suffix = "Keyboard";
	130	break;
	131	case HID_GD_MOUSE:
	132	suffix = "Mouse";
	133	break;
	134	case HID_GD_KEYPAD:
	135	suffix = "Pad";
	136	break;
	137	case HID_DG_PEN:
	138	suffix = "Pen";
	139	break;
	140	case HID_CP_CONSUMER_CONTROL:
	141	suffix = "Consumer Control";
	142	break;
	143	case HID_GD_SYSTEM_CONTROL:
	144	suffix = "System Control";
	145	break;
	146	}
	147
	148	if (suffix) {
	149	len = strlen(hdev->name) + 2 + strlen(suffix);
	150	name = devm_kzalloc(&hi->input->dev, len, GFP_KERNEL);
	151	if (name) {
	152	snprintf(name, len, "%s %s", hdev->name, suffix);
	153	hi->input->name = name;
	154	}
	155	}
	156
	157	return 0;
	158	}
	159
ff0c13d6 NK	160	static int uclogic_probe(struct hid_device *hdev,
	161	const struct hid_device_id *id)
	162	{
	163	int rc;
9614219e NK	164	struct uclogic_drvdata *drvdata = NULL;
9614219e NK	165	bool params_initialized = false;
ff0c13d6 NK	166
	167	/*
	168	* libinput requires the pad interface to be on a different node
	169	* than the pen, so use QUIRK_MULTI_INPUT for all tablets.
	170	*/
	171	hdev->quirks \|= HID_QUIRK_MULTI_INPUT;
	172
	173	/* Allocate and assign driver data */
	174	drvdata = devm_kzalloc(&hdev->dev, sizeof(*drvdata), GFP_KERNEL);
9614219e NK	175	if (drvdata == NULL) {
	176	rc = -ENOMEM;
	177	goto failure;
	178	}
01309e29	179	timer_setup(&drvdata->inrange_timer, uclogic_inrange_timeout, 0);
8a47670c	180	drvdata->re_state = U8_MAX;
ff0c13d6 NK	181	hid_set_drvdata(hdev, drvdata);
ff0c13d6 NK	182
9614219e NK	183	/* Initialize the device and retrieve interface parameters */
	184	rc = uclogic_params_init(&drvdata->params, hdev);
	185	if (rc != 0) {
	186	hid_err(hdev, "failed probing parameters: %d\n", rc);
	187	goto failure;
	188	}
	189	params_initialized = true;
	190	hid_dbg(hdev, "parameters:\n" UCLOGIC_PARAMS_FMT_STR,
	191	UCLOGIC_PARAMS_FMT_ARGS(&drvdata->params));
	192	if (drvdata->params.invalid) {
	193	hid_info(hdev, "interface is invalid, ignoring\n");
	194	rc = -ENODEV;
	195	goto failure;
	196	}
ff0c13d6	197
9614219e NK	198	/* Generate replacement report descriptor */
	199	rc = uclogic_params_get_desc(&drvdata->params,
	200	&drvdata->desc_ptr,
	201	&drvdata->desc_size);
	202	if (rc) {
	203	hid_err(hdev,
	204	"failed generating replacement report descriptor: %d\n",
	205	rc);
	206	goto failure;
ff0c13d6 NK	207	}
	208
	209	rc = hid_parse(hdev);
	210	if (rc) {
	211	hid_err(hdev, "parse failed\n");
9614219e	212	goto failure;
ff0c13d6 NK	213	}
	214
	215	rc = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
	216	if (rc) {
	217	hid_err(hdev, "hw start failed\n");
9614219e	218	goto failure;
ff0c13d6 NK	219	}
	220
	221	return 0;
9614219e NK	222	failure:
	223	/* Assume "remove" might not be called if "probe" failed */
	224	if (params_initialized)
	225	uclogic_params_cleanup(&drvdata->params);
	226	return rc;
ff0c13d6 NK	227	}
ff0c13d6 NK	228
251b4275 NK	229	#ifdef CONFIG_PM
	230	static int uclogic_resume(struct hid_device *hdev)
	231	{
	232	int rc;
	233	struct uclogic_params params;
	234
	235	/* Re-initialize the device, but discard parameters */
	236	rc = uclogic_params_init(&params, hdev);
	237	if (rc != 0)
	238	hid_err(hdev, "failed to re-initialize the device\n");
	239	else
	240	uclogic_params_cleanup(&params);
	241
	242	return rc;
	243	}
	244	#endif
	245
9614219e NK	246	static int uclogic_raw_event(struct hid_device *hdev,
	247	struct hid_report *report,
	248	u8 *data, int size)
ff0c13d6 NK	249	{
ff0c13d6 NK	250	struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev);
9614219e	251	struct uclogic_params *params = &drvdata->params;
ff0c13d6	252
9614219e NK	253	/* Tweak pen reports, if necessary */
	254	if (!params->pen_unused &&
	255	(report->type == HID_INPUT_REPORT) &&
	256	(report->id == params->pen.id) &&
ff0c13d6	257	(size >= 2)) {
9614219e NK	258	/* If it's the "virtual" frame controls report */
	259	if (params->frame.id != 0 &&
	260	data[1] & params->pen_frame_flag) {
	261	/* Change to virtual frame controls report ID */
	262	data[0] = params->frame.id;
	263	return 0;
	264	}
	265	/* If in-range reports are inverted */
	266	if (params->pen.inrange ==
	267	UCLOGIC_PARAMS_PEN_INRANGE_INVERTED) {
ff0c13d6 NK	268	/* Invert the in-range bit */
ff0c13d6 NK	269	data[1] ^= 0x40;
9614219e	270	}
59f2e0fc NK	271	/*
	272	* If report contains fragmented high-resolution pen
	273	* coordinates
	274	*/
	275	if (size >= 10 && params->pen.fragmented_hires) {
	276	u8 pressure_low_byte;
	277	u8 pressure_high_byte;
	278
	279	/* Lift pressure bytes */
	280	pressure_low_byte = data[6];
	281	pressure_high_byte = data[7];
	282	/*
	283	* Move Y coord to make space for high-order X
	284	* coord byte
	285	*/
	286	data[6] = data[5];
	287	data[5] = data[4];
	288	/* Move high-order X coord byte */
	289	data[4] = data[8];
	290	/* Move high-order Y coord byte */
	291	data[7] = data[9];
	292	/* Place pressure bytes */
	293	data[8] = pressure_low_byte;
	294	data[9] = pressure_high_byte;
	295	}
01309e29 NK	296	/* If we need to emulate in-range detection */
	297	if (params->pen.inrange == UCLOGIC_PARAMS_PEN_INRANGE_NONE) {
	298	/* Set in-range bit */
	299	data[1] \|= 0x40;
	300	/* (Re-)start in-range timeout */
	301	mod_timer(&drvdata->inrange_timer,
	302	jiffies + msecs_to_jiffies(100));
	303	}
ff0c13d6 NK	304	}
ff0c13d6 NK	305
fde44ac5 NK	306	/* Tweak frame control reports, if necessary */
	307	if ((report->type == HID_INPUT_REPORT) &&
	308	(report->id == params->frame.id)) {
	309	/* If need to, and can, set pad device ID for Wacom drivers */
	310	if (params->frame.dev_id_byte > 0 &&
	311	params->frame.dev_id_byte < size) {
	312	data[params->frame.dev_id_byte] = 0xf;
	313	}
8a47670c NK	314	/* If need to, and can, read rotary encoder state change */
	315	if (params->frame.re_lsb > 0 &&
	316	params->frame.re_lsb / 8 < size) {
	317	unsigned int byte = params->frame.re_lsb / 8;
	318	unsigned int bit = params->frame.re_lsb % 8;
	319
	320	u8 change;
	321	u8 prev_state = drvdata->re_state;
	322	/* Read Gray-coded state */
	323	u8 state = (data[byte] >> bit) & 0x3;
	324	/* Encode state change into 2-bit signed integer */
	325	if ((prev_state == 1 && state == 0) \|\|
	326	(prev_state == 2 && state == 3)) {
	327	change = 1;
	328	} else if ((prev_state == 2 && state == 0) \|\|
	329	(prev_state == 1 && state == 3)) {
	330	change = 3;
	331	} else {
	332	change = 0;
	333	}
	334	/* Write change */
	335	data[byte] = (data[byte] & ~((u8)3 << bit)) \|
	336	(change << bit);
	337	/* Remember state */
	338	drvdata->re_state = state;
	339	}
fde44ac5 NK	340	}
fde44ac5 NK	341
ff0c13d6 NK	342	return 0;
	343	}
	344
9614219e NK	345	static void uclogic_remove(struct hid_device *hdev)
	346	{
	347	struct uclogic_drvdata *drvdata = hid_get_drvdata(hdev);
	348
01309e29	349	del_timer_sync(&drvdata->inrange_timer);
9614219e NK	350	hid_hw_stop(hdev);
	351	kfree(drvdata->desc_ptr);
	352	uclogic_params_cleanup(&drvdata->params);
	353	}
	354
ff0c13d6 NK	355	static const struct hid_device_id uclogic_devices[] = {
	356	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
	357	USB_DEVICE_ID_UCLOGIC_TABLET_PF1209) },
	358	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
	359	USB_DEVICE_ID_UCLOGIC_TABLET_WP4030U) },
	360	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
	361	USB_DEVICE_ID_UCLOGIC_TABLET_WP5540U) },
	362	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
	363	USB_DEVICE_ID_UCLOGIC_TABLET_WP8060U) },
	364	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
	365	USB_DEVICE_ID_UCLOGIC_TABLET_WP1062) },
	366	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
	367	USB_DEVICE_ID_UCLOGIC_WIRELESS_TABLET_TWHL850) },
	368	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
	369	USB_DEVICE_ID_UCLOGIC_TABLET_TWHA60) },
9614219e NK	370	{ HID_USB_DEVICE(USB_VENDOR_ID_HUION,
	371	USB_DEVICE_ID_HUION_TABLET) },
	372	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
	373	USB_DEVICE_ID_HUION_TABLET) },
	374	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
	375	USB_DEVICE_ID_YIYNOVA_TABLET) },
	376	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
	377	USB_DEVICE_ID_UCLOGIC_UGEE_TABLET_81) },
	378	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
	379	USB_DEVICE_ID_UCLOGIC_UGEE_TABLET_45) },
0c15efe9 NK	380	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
0c15efe9 NK	381	USB_DEVICE_ID_UCLOGIC_UGEE_TABLET_47) },
9614219e NK	382	{ HID_USB_DEVICE(USB_VENDOR_ID_UCLOGIC,
	383	USB_DEVICE_ID_UCLOGIC_DRAWIMAGE_G3) },
	384	{ HID_USB_DEVICE(USB_VENDOR_ID_UGTIZER,
	385	USB_DEVICE_ID_UGTIZER_TABLET_GP0610) },
e902ed93 NK	386	{ HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
e902ed93 NK	387	USB_DEVICE_ID_UGEE_TABLET_G5) },
9614219e NK	388	{ HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
9614219e NK	389	USB_DEVICE_ID_UGEE_TABLET_EX07S) },
c3e5a67c NK	390	{ HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
c3e5a67c NK	391	USB_DEVICE_ID_UGEE_XPPEN_TABLET_G540) },
492a9e9a NK	392	{ HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
492a9e9a NK	393	USB_DEVICE_ID_UGEE_XPPEN_TABLET_G640) },
08367be1 NK	394	{ HID_USB_DEVICE(USB_VENDOR_ID_UGEE,
08367be1 NK	395	USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO01) },
ff0c13d6 NK	396	{ }
	397	};
	398	MODULE_DEVICE_TABLE(hid, uclogic_devices);
	399
	400	static struct hid_driver uclogic_driver = {
	401	.name = "uclogic",
	402	.id_table = uclogic_devices,
	403	.probe = uclogic_probe,
9614219e	404	.remove = uclogic_remove,
ff0c13d6 NK	405	.report_fixup = uclogic_report_fixup,
	406	.raw_event = uclogic_raw_event,
	407	.input_mapping = uclogic_input_mapping,
	408	.input_configured = uclogic_input_configured,
251b4275 NK	409	#ifdef CONFIG_PM
	410	.resume = uclogic_resume,
	411	.reset_resume = uclogic_resume,
	412	#endif
ff0c13d6 NK	413	};
	414	module_hid_driver(uclogic_driver);
	415
	416	MODULE_AUTHOR("Martin Rusko");
	417	MODULE_AUTHOR("Nikolai Kondrashov");
	418	MODULE_LICENSE("GPL");